Skip to content

Commit

Permalink
Update conf.py to fix RTD build
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyanndavis committed Oct 8, 2024
1 parent 91e10fb commit 2ab42a9
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions doc/api-docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@
# -- Options for HTML output ----------------------------------------------

import sphinx_rtd_theme

# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get('READTHEDOCS', '') == 'True':
if 'html_context' not in globals():
html_context = {}
html_context['READTHEDOCS'] = True

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
Expand Down Expand Up @@ -130,16 +137,16 @@
# dir menu entry, description, category)
texinfo_documents = [
('index', 'InVEST', 'InVEST Documentation',
'The Natural Capital Project', 'InVEST',
'The Natural Capital Project', 'InVEST',
'Integrated Valuation of Ecosystem Services and Tradeoffs',
'Scientific Software'),
]


# -- Prepare for sphinx build ---------------------------------------------

# Use sphinx apidoc tool to generate documentation for invest. Generated rst
# files go into the api/ directory. Note that some apidoc options may not work
# Use sphinx apidoc tool to generate documentation for invest. Generated rst
# files go into the api/ directory. Note that some apidoc options may not work
# the same because we aren't using their values in the custom templates
apidoc.main([
'--force', # overwrite any files from previous run
Expand All @@ -164,7 +171,7 @@
All InVEST models share a consistent python API:
- Every InVEST model has a corresponding module or subpackage in the
- Every InVEST model has a corresponding module or subpackage in the
``natcap.invest`` package
- The model modules contain a function called ``execute``
- The ``execute`` function takes a single argument (``args``), a dictionary
Expand Down

0 comments on commit 2ab42a9

Please sign in to comment.