mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 20:30:30 -06:00
Closes #585: document sphinx-apidoc.
This commit is contained in:
1 parent
853cfbf7b6
commit
38ebe67c4e
3 files changed
+80
-3
No files matched your search
@@ -6,7 +6,7 @@ sphinx-apidoc manual page
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
**sphinx-apidoc** [*options*] -o <*outputdir*> <*sourcedir*> [*filenames* ...]
|
||||
**sphinx-apidoc** [*options*] -o <*outputdir*> <*sourcedir*> [*pathnames* ...]
|
||||
|
||||
|
||||
Description
|
||||
@@ -16,6 +16,9 @@ Description
|
||||
that, using the autodoc extension, document a whole package in the style of
|
||||
other automatic API documentation tools.
|
||||
|
||||
*sourcedir* must point to a Python package. Any *pathnames* given are paths to
|
||||
be excluded from the generation.
|
||||
|
||||
|
||||
Options
|
||||
-------
|
||||
@@ -35,8 +38,8 @@ These options are used with ``-F``:
|
||||
|
||||
-H <project> Project name to put into the configuration.
|
||||
-A <author> Author name(s) to put into the configuration.
|
||||
-V <version> Project version, see :confval:`release`.
|
||||
-R <release> Project release, see :confval:`release`.
|
||||
-V <version> Project version.
|
||||
-R <release> Project release.
|
||||
|
||||
|
||||
See also
|
||||
|
||||
Reference in new issue
Block a user