Builders — Sphinx documentation

These are the built-in Sphinx builders. More builders can be added by extensions.
The builder’s “name” must be given to the -M or -b command-line options of sphinx-build to select a builder.
The most common builders are:
Build HTML pages. This is the default builder.
Build HTML pages, but with a single directory per document. Makes for prettier URLs (no .html) if served from a webserver.
Build a single HTML with the whole content.
Build HTML files with additional information for building a documentation collection in one of these formats.
Build an Apple Help Book. Requires hiutil and codesign, which are not Open Source and presently only available on Mac OS X 10.6 and higher.
Build LaTeX sources that can be compiled to a PDF document using pdflatex.
Build manual pages in groff format for UNIX systems.
Build Texinfo files that can be processed into Info files using makeinfo.
Build plain text files.
Build gettext-style message catalogs (.pot files).
Run all doctests in the documentation, if the doctest extension is enabled.
Check the integrity of all external links.
Build Docutils-native XML files.
Build compact pretty-printed “pseudo-XML” files displaying the internal structure of the intermediate document trees.
This is the standard HTML builder. Its output is a directory with HTML files, complete with style sheets and optionally the reStructuredText sources. There are quite a few configuration values that customize the output of this builder, see the chapter Options for HTML output for details.
The builder’s name. This is the value used to select builders on the command line.
The builder’s output format, or ‘’ if no document output is produced. This is commonly the file extension, e.g. “html”, though any string value is accepted. The builder’s format string can be used by various components such as SphinxPostTransform or extensions to determine their compatibility with the builder.
The list of MIME types of image formats supported by the builder. Image files are searched in the order in which they appear here.
This is a subclass of the standard HTML builder. Its output is a directory with HTML files, where each file is called index.html and placed in a subdirectory named like its page name. For example, the document markup/rest.rst will not result in an output file markup/rest.html, but markup/rest/index.html. When generating links between pages, the index.html is omitted, so that the URL would look like markup/rest/.
The builder’s name. This is the value used to select builders on the command line.
The builder’s output format, or ‘’ if no document output is produced. This is commonly the file extension, e.g. “html”, though any string value is accepted. The builder’s format string can be used by various components such as SphinxPostTransform or extensions to determine their compatibility with the builder.
The list of MIME types of image formats supported by the builder. Image files are searched in the order in which they appear here.
Added in version 0.6.
This is an HTML builder that combines the whole project in one output file. (Obviously this only works with smaller projects.) The file is named like the root document. No indices will be generated.
The builder’s name. This is the value used to select builders on the command line.
The builder’s output format, or ‘’ if no document output is produced. This is commonly the file extension, e.g. “html”, though any string value is accepted. The builder’s format string can be used by various components such as SphinxPostTransform or extensions to determine their compatibility with the builder.
The list of MIME types of image formats supported by the builder. Image files are searched in the order in which they appear here.
Added in version 1.0.
This builder produces the same output as the standalone HTML builder, but also generates HTML Help support files that allow the Microsoft HTML Help Workshop to compile them into a CHM file.
The builder’s name. This is the value used to select builders on the command line.
The builder’s output format, or ‘’ if no document output is produced. This is commonly the file extension, e.g. “html”, though any string value is accepted. The builder’s format string can be used by various components such as SphinxPostTransform or extensions to determine their compatibility with the builder.
The list of MIME types of image formats supported by the builder. Image files are searched in the order in which they appear here.
This builder produces the same output as the standalone HTML builder, but also generates Qt help collection support files that allow the Qt collection generator to compile them.
Changed in version 2.0: Moved to sphinxcontrib.qthelp from sphinx.builders package.
The builder’s name. This is the value used to select builders on the command line.
The builder’s output format, or ‘’ if no document output is produced. This is commonly the file extension, e.g. “html”, though any string value is accepted. The builder’s format string can be used by various components such as SphinxPostTransform or extensions to determine their compatibility with the builder.
The list of MIME types of image formats supported by the builder. Image files are searched in the order in which they appear here.