sphinxcontrib apidoc

docs/src/Makefile

@@ -8,8 +8,6 @@ SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 
-API_SOURCE    = ../../esmf_regrid
-
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -18,7 +16,5 @@ help:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-# Start by auto-generating the API files.
 %: Makefile
-	sphinx-apidoc -f -e -H API -o "$(SOURCEDIR)/_api_generated" "$(API_SOURCE)" "$(API_SOURCE)/tests"
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/src/conf.py

@@ -44,6 +44,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "sphinxcontrib.apidoc",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -118,6 +119,17 @@
 }
 
 
-# -- todo_ configuration -----------------------------------------------
+# -- todo_ extension ----------------------------------------------------------
 # See https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
 todo_include_todos = True
+
+
+# -- apidoc extension ---------------------------------------------------------
+# See https://github.com/sphinx-contrib/apidoc
+module_dir = source_code_root / "esmf_regrid"
+
+apidoc_module_dir = str(module_dir)
+apidoc_output_dir = str(Path(__file__).parent / "_api_generated")
+apidoc_excluded_paths = [str(module_dir / "tests")]
+apidoc_separate_modules = True
+apidoc_extra_args = ["-H", "API"]

requirements/py38.yml

@@ -33,3 +33,4 @@ dependencies:
   - pydata-sphinx-theme
   - sphinx
   - sphinx-copybutton
+  - sphinxcontrib-apidoc