Building the Docs

The load-atoms package is documented using sphinx. Per-dataset pages and information are automatically generated from the metadata files using scripts found in dev/scripts.

To update the documentation to reflect changes to a single dataset, run:

python dev/scripts/generate_page.py <dataset-id>

To update the documentation to reflect changes to all datasets, run:

python dev/scripts/rebuild_all_docs.py

To preview the docs locally, run:

sphinx-autobuild docs/source docs/build