.\" Man page generated from reStructuredText.
.
.TH "SPHINX-APIDOC" "1" "Dec 27, 2016" "1.4.9" "Sphinx"
.SH NAME
sphinx-apidoc \- Sphinx API doc generator tool
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBsphinx\-apidoc\fP [\fIoptions\fP] \-o <\fIoutputdir\fP> <\fIsourcedir\fP> [\fIpathnames\fP ...]
.SH DESCRIPTION
.sp
\fBsphinx\-apidoc\fP is a tool for automatic generation of Sphinx sources
that, using the autodoc extension, document a whole package in the style of
other automatic API documentation tools.
.sp
\fIsourcedir\fP must point to a Python package.  Any \fIpathnames\fP given are paths to
be excluded from the generation.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
\fBsphinx\-apidoc\fP generates source files that use \fBsphinx.ext.autodoc\fP
to document all found modules.  If any modules have side effects on import,
these will be executed by \fBautodoc\fP when \fBsphinx\-build\fP is run.
.sp
If you document scripts (as opposed to library modules), make sure their main
routine is protected by a \fBif __name__ == \(aq__main__\(aq\fP condition.
.UNINDENT
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.TP
.BI \-o \ <outputdir>
Directory to place the output files.  If it does not exist,
it is created.
.TP
.B \-f\fP,\fB  \-\-force
Usually, apidoc does not overwrite files, unless this option
is given.
.TP
.B \-l\fP,\fB  \-\-follow\-links
Follow symbolic links.
.TP
.B \-n\fP,\fB  \-\-dry\-run
If given, apidoc does not create any files.
.TP
.BI \-s \ <suffix>
Suffix for the source files generated, default is \fBrst\fP\&.
.TP
.BI \-d \ <maxdepth>
Maximum depth for the generated table of contents file.
.TP
.B \-T\fP,\fB  \-\-no\-toc
Do not create a table of contents file.
.TP
.B \-F\fP,\fB  \-\-full
If given, a full Sphinx project is generated (\fBconf.py\fP,
\fBMakefile\fP etc.) using sphinx\-quickstart.
.TP
.B \-e\fP,\fB  \-\-separate
Put each module file in its own page.
.TP
.B \-E\fP,\fB  \-\-no\-headings
Don\(aqt create headings for the modules/packages
.TP
.B \-P\fP,\fB  \-\-private
Include "_private" modules
.UNINDENT
.sp
These options are used with \fB\-F\fP:
.INDENT 0.0
.TP
.BI \-H \ <project>
Project name to put into the configuration.
.TP
.BI \-A \ <author>
Author name(s) to put into the configuration.
.TP
.BI \-V \ <version>
Project version.
.TP
.BI \-R \ <release>
Project release.
.UNINDENT
.SH SEE ALSO
.sp
\fBsphinx\-build(1)\fP
.SH AUTHOR
.sp
Etienne Desautels, <\fI\%etienne.desautels@gmail.com\fP>, Georg Brandl
<\fI\%georg@python.org\fP> et al.
.SH COPYRIGHT
2007-2016, Georg Brandl and the Sphinx team
.\" Generated by docutils manpage writer.
.