xarray-contrib · djhoese · Oct 23, 2022 · Oct 24, 2022
diff --git a/.gitignore b/.gitignore
@@ -56,6 +56,7 @@ coverage.xml
 # Sphinx documentation
 doc/_build/
 doc/generated/
+doc/api/
 
 # PyBuilder
 target/

diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml
@@ -14,6 +14,7 @@ dependencies:
   - pangeo-sphinx-book-theme
   - pytest
   - sphinx
+  - sphinxcontrib-apidoc
   - sphinx-autosummary-accessors
   - sphinx-copybutton
   - xarray

diff --git a/doc/Makefile b/doc/Makefile
@@ -49,6 +49,7 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf generated/*
+	rm -rf api/*
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

diff --git a/doc/api.rst b/doc/api.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -52,6 +52,7 @@
     "IPython.sphinxext.ipython_console_highlighting",
     "sphinx_autosummary_accessors",
     "sphinx_copybutton",
+    "sphinxcontrib.apidoc",
 ]
 
 # never execute notebooks: avoids lots of expensive imports on rtd
@@ -83,6 +84,13 @@ def setup(app):
 numpydoc_class_members_toctree = False
 numpydoc_show_class_members = False
 
+# API docs
+
+apidoc_module_dir = "../xbatcher"
+apidoc_output_dir = "api"
+apidoc_excluded_paths = []
+apidoc_separate_modules = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -62,6 +62,6 @@ or via a built-in `Xarray accessor <http://xarray.pydata.org/en/stable/internals
    :caption: Contents:
 
    roadmap
-   api
+   API reference <api/modules>
    demo
    contributing