sphinx-build

NAME

sphinx-build − Sphinx documentation generator tool

SYNOPSIS

sphinx-build [options] <sourcedir> <outdir> [filenames...]

DESCRIPTION

sphinx-build generates documentation from the files in <sourcedir> and places it to the <outdir>.

sphinx-build looks for <sourcedir>/conf.py for the configuration settings. sphinx-quickstart(1) may be used to generate template files, including conf.py.

sphinx-build can create documentation in different formats. Format is selected by specifying builder in command line and defaults to HTML. Builders can also perform other tasks related to the documentation processing.

List of available builders:

	html		HTML files generation. This is default builder.
	web		Generating files for sphinx-web (currently undergo the full rewrite, and not working).

htmlhelp

Generates files for CHM generation.

latex

Generates LaTeX version of documentation. This builder uses PAPER environment variable (e.g. PAPER=a4 or PAPER=letter) if available.

changes

Shows changed/added/deprecated items since last documentation generation.

linkcheck

Checks the integrity of all external links in documentation

OPTIONS

-b <builder>

Builder to use; defaults to html. See the full list of builders above.

<filename>

Force to generate documentation for the file

	-a		Generate all files; without this option only documentation for new and changed files is generated
	-E		Ignore cached files, forces to re-read all files from disk.

-d <path>

Path to cached environment; defaults to <outdir>/.doctrees

-D <setting>=<value>

Overrides setting from <sourcedir>/conf.py

	-N		Do not do colored output
	-q		Quiet operation, just prints warnings and errors on stderr
	-P		Run Pdb on exception

AUTHOR

Georg Brandl <georg AT python DOT org>, Armin Ronacher <armin DOT ronacher AT active-4 DOT com> et al.

This manual page was written by Mikhail Gusarov <dottedmag AT dottedmag DOT net>, for the Debian project (but may be used by others).

pdf