# sphinx / doc / builders.rst

 georg.brandl 186cf92 2008-03-09 georg.brandl 4ca916f 2008-03-16 georg.brandl 186cf92 2008-03-09 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl 186cf92 2008-03-09 georg.brandl 4ca916f 2008-03-16 georg.brandl 186cf92 2008-03-09 georg.brandl 4ca916f 2008-03-16 georg.brandl c9ff353 2008-03-23 georg.brandl 4ca916f 2008-03-16 georg.brandl b3fff67 2008-03-12 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl b3fff67 2008-03-12 georg.brandl 4ca916f 2008-03-16 georg.brandl b3fff67 2008-03-12 Georg Brandl 357b402 2009-02-18 georg.brandl b3fff67 2008-03-12 georg.brandl 4ca916f 2008-03-16 Georg Brandl def6a37 2009-01-10 georg.brandl 4ca916f 2008-03-16 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl b3fff67 2008-03-12 georg.brandl 4ca916f 2008-03-16 Georg Brandl ea7177b 2008-11-22 georg.brandl 4ca916f 2008-03-16 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl d3f1bfa 2008-06-01 armin.ronacher 10c645b 2008-06-26 Georg Brandl 5ea1e4f 2008-11-29 armin.ronacher 10c645b 2008-06-26 armin.ronacher 716dd26 2008-06-26 armin.ronacher 10c645b 2008-06-26 armin.ronacher 716dd26 2008-06-26 armin.ronacher 10c645b 2008-06-26 armin.ronacher 5a3a7cc 2008-06-26 armin.ronacher 716dd26 2008-06-26 armin.ronacher 10c645b 2008-06-26 Georg Brandl def6a37 2009-01-10 armin.ronacher 10c645b 2008-06-26 Georg Brandl 61a7856 2008-11-22 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl b3fff67 2008-03-12 georg.brandl 4ca916f 2008-03-16 Georg Brandl 5ea1e4f 2008-11-29 georg.brandl b3fff67 2008-03-12 georg.brandl 4ca916f 2008-03-16 georg.brandl 4fa041e 2008-03-21 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26 georg.brandl 208a0d3 2008-03-25 armin.ronacher 10c645b 2008-06-26   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 .. _builders: Available builders ================== .. module:: sphinx.builders :synopsis: Available built-in builder classes. These are the built-in Sphinx builders. More builders can be added by :ref:extensions . The builder's "name" must be given to the **-b** command-line option of :program:sphinx-build to select a builder. .. module:: sphinx.builders.html .. class:: StandaloneHTMLBuilder 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. .. class:: DirectoryHTMLBuilder 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/. Its name is dirhtml. .. versionadded:: 0.6 .. class:: HTMLHelpBuilder 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. .. module:: sphinx.builders.latex .. class:: LaTeXBuilder 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. .. note:: The produced LaTeX file uses several LaTeX packages that may not be present in a "minimal" TeX distribution installation. For TeXLive, the following packages need to be installed: * latex-recommended * latex-extra * fonts-recommended Its name is latex. .. module:: sphinx.builders.text .. class:: TextBuilder This builder produces a text file for each reST file -- this is almost the same as the reST source, but with much of the markup stripped for better readability. Its name is text. .. versionadded:: 0.4 .. currentmodule:: sphinx.builders.html .. class:: SerializingHTMLBuilder This builder uses a module that implements the Python serialization API (pickle, simplejson, phpserialize, and others) to dump the generated HTML documentation. The pickle builder is a subclass of it. A concreate subclass of this builder serializing to the PHP serialization_ format could look like this:: import phpserialize class PHPSerializedBuilder(SerializingHTMLBuilder): name = 'phpserialized' implementation = phpserialize out_suffix = '.file.phpdump' globalcontext_filename = 'globalcontext.phpdump' searchindex_filename = 'searchindex.phpdump' .. _PHP serialization: http://pypi.python.org/pypi/phpserialize .. attribute:: implementation A module that implements dump(), load(), dumps() and loads() functions that conform to the functions with the same names from the pickle module. Known modules implementing this interface are simplejson (or json in Python 2.6), phpserialize, plistlib, and others. .. attribute:: out_suffix The suffix for all regular files. .. attribute:: globalcontext_filename The filename for the file that contains the "global context". This is a dict with some general configuration values such as the name of the project. .. attribute:: searchindex_filename The filename for the search index Sphinx generates. See :ref:serialization-details for details about the output format. .. versionadded:: 0.5 .. class:: PickleHTMLBuilder 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. See :ref:serialization-details for details about the output format. Its name is pickle. (The old name web still works as well.) The file suffix is .fpickle. The global context is called globalcontext.pickle, the search index searchindex.pickle. .. class:: JSONHTMLBuilder This builder produces a directory with JSON 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. See :ref:serialization-details for details about the output format. Its name is json. The file suffix is .fjson. The global context is called globalcontext.json, the search index searchindex.json. .. versionadded:: 0.5 .. module:: sphinx.builders.changes .. class:: ChangesBuilder 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. .. module:: sphinx.builders.linkcheck .. class:: CheckExternalLinksBuilder 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: * :mod:~sphinx.ext.doctest * :mod:~sphinx.ext.coverage .. _serialization-details: Serialization builder details ----------------------------- All serialization builders outputs one file per source file and a few special files. They also copy the reST source files in the directory _sources under the output directory. The :class:PickleHTMLBuilder is a builtin subclass that implements the pickle serialization interface. The files per source file have the extensions of :attr:~SerializingHTMLBuilder.out_suffix, and are arranged in directories just as the source files are. They unserialize to a dictionary (or dictionary like structure) with these keys: body The HTML "body" (that is, the HTML rendering of the source file), as rendered by the HTML translator. title The title of the document, as HTML (may contain markup). toc The table of contents for the file, rendered as an HTML 
. display_toc A boolean that is True if the toc contains more than one entry. current_page_name The document name of the current file. parents, prev and next Information about related chapters in the TOC tree. Each relation is a dictionary with the keys link (HREF for the relation) and title (title of the related document, as HTML). parents is a list of relations, while prev and next are a single relation. sourcename The name of the source file under _sources. The special files are located in the root output directory. They are: :attr:SerializingHTMLBuilder.globalcontext_filename A pickled dict with these keys: project, copyright, release, version The same values as given in the configuration file. style, use_modindex :confval:html_style and :confval:html_use_modindex, respectively. last_updated Date of last build. builder Name of the used builder, in the case of pickles this is always 'pickle'. titles A dictionary of all documents' titles, as HTML strings. :attr:SerializingHTMLBuilder.searchindex_filename An index that can be used for searching the documentation. It is a pickled list with these entries: * A list of indexed docnames. * A list of document titles, as HTML strings, in the same order as the first list. * A dict mapping word roots (processed by an English-language stemmer) to a list of integers, which are indices into the first list. environment.pickle The build environment. This is always a pickle file, independent of the builder and a copy of the environment that was used when the builder was started. (XXX: document common members) Unlike the other pickle files this pickle file requires that the sphinx module is available on unpickling. 
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.