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  <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PAT‐
10       TERN, …]
11

DESCRIPTION

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

OPTIONS

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

ENVIRONMENT

110       SPHINX_APIDOC_OPTIONS
111              A comma-separated list of option to append to generated automod‐
112              ule  directives.  Defaults to members,undoc-members,show-inheri‐
113              tance.
114

SEE ALSO

116       sphinx-build(1), sphinx-autogen(1)
117

119       2007-2019, Georg Brandl and the Sphinx team
120
121
122
123
1242.1.2                            Jul 26, 2019                 SPHINX-APIDOC(1)
Impressum