summaryrefslogtreecommitdiff
path: root/doc/man/sphinx-apidoc.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/sphinx-apidoc.rst')
-rw-r--r--doc/man/sphinx-apidoc.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/man/sphinx-apidoc.rst b/doc/man/sphinx-apidoc.rst
index 803466040..9a13f1401 100644
--- a/doc/man/sphinx-apidoc.rst
+++ b/doc/man/sphinx-apidoc.rst
@@ -91,7 +91,7 @@ Options
Interpret paths recursively according to PEP-0420.
-.. option:: -M
+.. option:: -M, --module-first
Put module documentation before submodule documentation.
@@ -118,6 +118,14 @@ These options are used when :option:`--full` is specified:
Sets the project release to put in generated files (see :confval:`release`).
+Environment
+-----------
+
+.. envvar:: SPHINX_APIDOC_OPTIONS
+
+ A comma-separated list of option to append to generated ``automodule``
+ directives. Defaults to ``members,undoc-members,show-inheritance``.
+
See also
--------