VeniVidiVici
/
invest
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update api docs conf.py

This commit is contained in:
Emily Soth 2025-05-23 12:05:48 -07:00
parent cb8c045ad2
commit 32ab8f2350
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api-docs/conf.py
View File

@ -20,6 +20,7 @@ import sys
from unittest.mock import MagicMock from unittest.mock import MagicMock
import natcap.invest import natcap.invest
from natcap.invest import models
from sphinx.ext import apidoc from sphinx.ext import apidoc
DOCS_SOURCE_DIR = os.path.dirname(__file__) DOCS_SOURCE_DIR = os.path.dirname(__file__)
@ -199,8 +200,8 @@ MODEL_ENTRYPOINTS_FILE = os.path.join(DOCS_SOURCE_DIR, 'models.rst')
# Write sphinx autodoc function for each entrypoint # Write sphinx autodoc function for each entrypoint
with open(MODEL_ENTRYPOINTS_FILE, 'w') as models_rst: with open(MODEL_ENTRYPOINTS_FILE, 'w') as models_rst:
models_rst.write(MODEL_RST_TEMPLATE) models_rst.write(MODEL_RST_TEMPLATE)
for model_id, pyname in sorted(natcap.invest.models.model_id_to_pyname.items()): for model_id, pyname in sorted(models.model_id_to_pyname.items()):
model_title = natcap.invest.models.model_id_to_spec[model_id].model_title model_title = models.model_id_to_spec[model_id].model_title
underline = ''.join(['=']*len(model_title)) underline = ''.join(['=']*len(model_title))
models_rst.write( models_rst.write(
f'{model_title}\n' f'{model_title}\n'