The sphinx-build script builds a Sphinx documentation set. It is called like this:
$ sphinx-build [options] sourcedir builddir [filenames]
where sourcedir is the source directory, and builddir is the directory in which you want to place the built documentation. Most of the time, you don’t need to specify any filenames.
The sphinx-build script has several options:
The most important option: it selects a builder. The most common builders are:
See Available builders for a list of all builders shipped with Sphinx. Extensions can add their own builders.
If given, always write all output files. The default is to only write output files for new and changed source files. (This may not apply to all builders.)
Don’t use a saved environment (the structure caching all cross-references), but rebuild it completely. The default is to only read and parse source files that are new or have changed since the last run.
Define the tag tag. This is relevant for only directives that only include their content if this tag is set.
New in version 0.6.
Since Sphinx has to read and parse all source files before it can write an output file, the parsed source files are cached as “doctree pickles”. Normally, these files are put in a directory called .doctrees under the build directory; with this option you can select a different cache directory (the doctrees can be shared between all builders).
Don’t look for the conf.py in the source directory, but use the given configuration directory instead. Note that various other files and paths given by configuration values are expected to be relative to the configuration directory, so they will have to be present at this location too.
New in version 0.3.
Don’t look for a configuration file; only take options via the -D option.
New in version 0.5.
Override a configuration value set in the conf.py file. The value must be a string or dictionary value. For the latter, supply the setting name and key like this: -D latex_elements.docclass=scrartcl. For boolean values, use 0 or 1 as the value.
Changed in version 0.6: The value can now be a dictionary value.
Make the name assigned to value in the HTML templates.
New in version 0.5.
Run in nit-picky mode. Currently, this generates warnings for all missing references.
Do not emit colored output. (On Windows, colored output is disabled in any case.)
Do not output anything on standard output, only write warnings and errors to standard error.
Do not output anything on standard output, also suppress warnings. Only errors are written to standard error.
Write warnings (and errors) to the given file, in addition to standard error.
Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1.
(Useful for debugging only.) Run the Python debugger, pdb, if an unhandled exception occurs while building.
You can also give one or more filenames on the command line after the source and build directories. Sphinx will then try to build only these output files (and their dependencies).
The value for latex_paper_size.
The command to use instead of sphinx-build.
The build directory to use instead of the one chosen in sphinx-quickstart.
Additional options for sphinx-build.
The sphinx-apidoc generates completely automatic API documentation for a Python package. It is called like this:
$ sphinx-apidoc [options] -o outputdir packagedir [pathnames]
where packagedir is the path to the package to document, and outputdir is the directory where the generated sources are placed. Any pathnames given are paths to be excluded ignored during generation.
The sphinx-apidoc script has several options:
Gives the directory in which to place the generated output.
Normally, sphinx-apidoc does not overwrite any files. Use this option to force the overwrite of all files that it generates.
With this option given, no files will be written at all.
This option selects the file name suffix of output files. By default, this is rst.
This sets the maximum depth of the table of contents, if one is generated.
This prevents the generation of a table-of-contents file modules.rst. This has no effect when --full is given.
This option makes sphinx-apidoc create a full Sphinx project, using the same mechanism as sphinx-quickstart. Most configuration values are set to default values, but you can influence the most important ones using the following options.