Skip to content

Commit

Permalink
Add documentation about generating area list docs
Browse files Browse the repository at this point in the history
  • Loading branch information
djhoese committed Aug 29, 2024
1 parent e804b70 commit 084b114
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/source/dev_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,15 @@ additional packages are needed. These can be installed with ::

pip install -e ".[doc]"

Generating the documentation requires a one-time script to generate a list
of previews of all of the AreaDefinition objects used by the documentation.
This script can take 2+ minutes to execute so it is run separately from the
normal documentation build process. To run it::

cd doc/source/
python generate_area_def_list.py
cd ../../

After editing the source files there the documentation can be generated locally::

cd doc
Expand Down

0 comments on commit 084b114

Please sign in to comment.