sphinx / doc / builders.rst

Available builders

These are the built-in Sphinx builders. More builders can be added by :ref:`extensions <extensions>`.

The builder's "name" must be given to the -b command-line option of :program:`sphinx-build.py` to select a builder.

This is the standard HTML builder. Its output is a directory with HTML files, complete with style sheets and optionally the reST sources. There are quite a few configuration values that customize the output of this builder, see the chapter :ref:`html-options` for details.

Its name is html.

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.

Its name is htmlhelp.

This builder produces a directory with pickle files containing mostly HTML fragments and TOC information, for use of a web application (or custom postprocessing tool) that doesn't use the standard HTML templates.

It also is the format used by the Sphinx Web application. Its name is web.

This builder produces a bunch of LaTeX files in the output directory. You have to specify which documents are to be included in which LaTeX files via the :confval:`latex_documents` configuration value. There are a few configuration values that customize the output of this builder, see the chapter :ref:`latex-options` for details.

Its name is latex.

This builder produces an HTML overview of all :dir:`versionadded`, :dir:`versionchanged` and :dir:`deprecated` directives for the current :confval:`version`. This is useful to generate a ChangeLog file, for example.

Its name is changes.

This builder scans all documents for external links, tries to open them with :mod:`urllib2`, and writes an overview which ones are broken and redirected to standard output and to :file:`output.txt` in the output directory.

Its name is linkcheck.

Built-in Sphinx extensions that offer more builders are:

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.