IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4356 from stephenfin/bug/2250

Browse Source 
doc: Add missing sphinx-apidocs opt, envvar
This commit is contained in:
Takeshi KOMIYA 2017-12-29 10:02:43 +09:00 committed by GitHub
commit 8c542e1222
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/man/sphinx-apidoc.rst
View File

@ -91,7 +91,7 @@ Options
Interpret paths recursively according to PEP-0420. Interpret paths recursively according to PEP-0420.
.. option:: -M .. option:: -M, --module-first
Put module documentation before submodule documentation. 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`). 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 See also
-------- --------