From 084b1144b2019a86d47c0dc9e5f2f62752a8c565 Mon Sep 17 00:00:00 2001 From: David Hoese Date: Thu, 29 Aug 2024 11:19:16 -0500 Subject: [PATCH] Add documentation about generating area list docs --- doc/source/dev_guide/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/source/dev_guide/index.rst b/doc/source/dev_guide/index.rst index bbd9bedaf4..0df47a866c 100644 --- a/doc/source/dev_guide/index.rst +++ b/doc/source/dev_guide/index.rst @@ -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