Use sphinxcontrib-apidoc

To build API documentation as part of sphinx-build, rather than requiring a prior separate invocation of sphinx-apidoc (which requires additional knowledge/configuration, e.g. on Read the Docs). See: readthedocs/readthedocs.org#1139 sphinx-doc/sphinx#4101 Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
kevinoid · Jun 18, 2022 · 1007ae3 · 1007ae3
1 parent 7ffeb9e
commit 1007ae3
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -69,6 +69,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinxarg.ext',
+    'sphinxcontrib.apidoc',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -213,6 +214,10 @@
 
 # -- Extension configuration -------------------------------------------------
 
+# -- Options for apidoc extension --------------------------------------------
+
+apidoc_module_dir = '../src/packagename'
+
 # -- Options for intersphinx extension ---------------------------------------
 
 # Map external identifiers to (base URI, inventory) pair.  None is objects.inv

diff --git a/requirements/docs.in b/requirements/docs.in
@@ -1,3 +1,4 @@
 # Abstract top-level documentation generator dependencies
 Sphinx
 sphinx-argparse
+sphinxcontrib-apidoc
diff --git a/tox.ini b/tox.ini
@@ -23,7 +23,6 @@ commands = python -bb -m pytest --cov={envsitepackagesdir}{/}packagename {posarg
 [testenv:docs]
 commands_pre = pip install -rrequirements/docs.in
 commands =
-    sphinx-apidoc -o docs/api src/packagename
     sphinx-build -nW -j auto docs docs/_build
 
 [testenv:lint]