1SPHINX-APIDOC(1)                    Sphinx                    SPHINX-APIDOC(1)
2
3
4

NAME

6       sphinx-apidoc - Sphinx API doc generator tool
7

SYNOPSIS

9       sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames …]
10

DESCRIPTION

12       sphinx-apidoc  is  a  tool  for  automatic generation of Sphinx sources
13       that, using the autodoc extension, document  a  whole  package  in  the
14       style of other automatic API documentation tools.
15
16       sourcedir is the path to a Python package to document, and outputdir is
17       the directory where the generated sources  are  placed.  Any  pathnames
18       given are paths to be excluded from the generation.
19
20       WARNING:
21          sphinx-apidoc  generates source files that use sphinx.ext.autodoc to
22          document all found modules.  If any modules  have  side  effects  on
23          import, these will be executed by autodoc when sphinx-build is run.
24
25          If  you  document scripts (as opposed to library modules), make sure
26          their main routine is protected by a if __name__ == '__main__'  con‐
27          dition.
28

OPTIONS

30       -o <outputdir>
31              Directory to place the output files. If it does not exist, it is
32              created.
33
34       -f, --force
35              Force overwritting of any existing generated files.
36
37       -l, --follow-links
38              Follow symbolic links.
39
40       -n, --dry-run
41              Do not create any files.
42
43       -s <suffix>
44              Suffix for the source files generated. Defaults to rst.
45
46       -d <maxdepth>
47              Maximum depth for the generated table of contents file.
48
49       -T, --no-toc
50              Do not create a table of contents file. Ignored when  --full  is
51              provided.
52
53       -F, --full
54              Generate  a  full  Sphinx project (conf.py, Makefile etc.) using
55              the same mechanism as sphinx-quickstart.
56
57       -e, --separate
58              Put documentation for each module on its own page.
59
60              New in version 1.2.
61
62
63       -E, --no-headings
64              Do not create headings for the modules/packages. This is useful,
65              for example, when docstrings already contain headings.
66
67       -P, --private
68              Include “_private” modules.
69
70              New in version 1.2.
71
72
73       --implicit-namespaces
74              By  default  sphinx-apidoc processes sys.path searching for mod‐
75              ules only.  Python 3.3 introduced PEP  420  implicit  namespaces
76              that  allow  module path structures such as foo/bar/module.py or
77              foo/bar/baz/__init__.py (notice that bar and foo are namespaces,
78              not modules).
79
80              Interpret paths recursively according to PEP-0420.
81
82       -M, --module-first
83              Put module documentation before submodule documentation.
84
85       These options are used when --full is specified:
86
87       -a     Append module_path to sys.path.
88
89       -H <project>
90              Sets the project name to put in generated files (see project).
91
92       -A <author>
93              Sets  the  author  name(s)  to put in generated files (see copy‐
94              right).
95
96       -V <version>
97              Sets the project version to put in  generated  files  (see  ver‐
98              sion).
99
100       -R <release>
101              Sets  the  project  release  to  put  in  generated  files  (see
102              release).
103

ENVIRONMENT

105       SPHINX_APIDOC_OPTIONS
106              A comma-separated list of option to append to generated automod‐
107              ule  directives.  Defaults to members,undoc-members,show-inheri‐
108              tance.
109

SEE ALSO

111       sphinx-build(1), sphinx-autogen(1)
112

114       2007-2018, Georg Brandl and the Sphinx team
115
116
117
118
1191.7.6                            Aug 02, 2018                 SPHINX-APIDOC(1)
Impressum