README.md

Writing and maintaining documentation

Documentation for the JWST calibration pipeline is written in Sphinx reStructuredText (.rst) in the docs/ directory, and is hosted online on ReadTheDocs at https://jwst-pipeline.readthedocs.io

ReadTheDocs hosts several versions of the documentation. To switch between versions, use the version selector in the corner of the page:

• stable is built from the last released version. If you successfully merge a PR with documentation changes, your changes will not be reflected in stable until the next version of JWST is released.
• latest is built from the latest commit on main.
• A static version is also built for each release.

Building documentation locally

ReadTheDocs will automatically build documentation for your branch when you push a commit to a pull request on the jwst GitHub repository, and host a temporary build with a visual diff. However, it is also good practice to build the docs locally if you are editing them, to reduce frustration from small errors.

To build the docs locally (assuming you have set up your environment as described in CONTRIBUTING.md):

pip install -e .[docs]
cd docs/
make clean
make html

The docs will build to docs/_build/html/. Open docs/_build/html/index.html to view the pages in your browser.