diff --git a/.readthedocs.yml b/.readthedocs.yml index fbf80e08..5138f8f0 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -14,6 +14,9 @@ build: os: ubuntu-22.04 tools: python: "mambaforge-22.9" + jobs: + pre_build: + - sphinx-apidoc -o docs/apidoc --private --module-first xhydro conda: environment: environment-docs.yml diff --git a/docs/conf.py b/docs/conf.py index 20506e13..4d104faa 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,7 @@ pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False +todo_include_todos = True # -- Options for HTML output ------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 4d4f1fb4..3f2923f5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ Welcome to xHydro's documentation! readme installation usage - modules + apidoc/modules contributing authors history