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 #3670 from mahilleb-msft/sphinx-apidoc-document-missing-options

Browse Source 
doc/invocation.rst: document missing options for sphinx-apidoc
This commit is contained in:
Takeshi KOMIYA 2017-04-26 23:56:45 +09:00 committed by GitHub
commit 7dee9a1d89
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/invocation.rst
View File

@ -480,6 +480,18 @@ The :program:`sphinx-apidoc` script has several options:
With this option given, no files will be written at all. With this option given, no files will be written at all.
.. option:: -e, --separate
Put documentation for each module on its own page.
.. versionadded:: 1.2
.. option:: -P, --private
Include "_private" modules.
.. versionadded:: 1.2
.. option:: -s suffix .. option:: -s suffix
This option selects the file name suffix of output files. By default, this This option selects the file name suffix of output files. By default, this
@ -505,6 +517,13 @@ The :program:`sphinx-apidoc` script has several options:
This prevents the generation of a table-of-contents file ``modules.rst``. This prevents the generation of a table-of-contents file ``modules.rst``.
This has no effect when :option:`--full` is given. This has no effect when :option:`--full` is given.
.. option:: -E, --no-headings
Don't create headings for the module/package packages (e.g. when the
docstrings already contain them).
.. versionadded:: 1.2
.. option:: -F, --full .. option:: -F, --full
This option makes sphinx-apidoc create a full Sphinx project, using the same This option makes sphinx-apidoc create a full Sphinx project, using the same