diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-01-08 20:19:36 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2018-01-08 20:19:36 +0900 |
| commit | 326d7e64cedb5280a9cf51a90c00266e1dab9e7b (patch) | |
| tree | 0ce4e7845e09aa822da027fbe6401174458c47d9 /doc/man/sphinx-apidoc.rst | |
| parent | 7a194f52960fe5ace04ef7daa72563e6d3bf094f (diff) | |
| parent | 3965b1f023bbac932d0dfbf414386f0667ec002a (diff) | |
| download | sphinx-git-326d7e64cedb5280a9cf51a90c00266e1dab9e7b.tar.gz | |
Merge branch 'master' into dont_emit_system_message_on_autodoc_warning
Diffstat (limited to 'doc/man/sphinx-apidoc.rst')
| -rw-r--r-- | doc/man/sphinx-apidoc.rst | 10 |
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 -------- |