IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: Rework "builders" document

Browse Source 
There are a number of cleanup items.

- Some paragraphs are reworded or clarified
- Semantic markup is added where possible
- Everything is wrapped to ~80 characters

A number of TODOs are inserted. These will be resolved separately.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane 2018-02-06 11:25:43 +00:00
parent f61593b535
commit 7e27e09493
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/builders.rst
View File

@ -1,7 +1,8 @@
.. _builders: .. _builders:
Available builders ========
================== Builders
========
.. module:: sphinx.builders .. module:: sphinx.builders
:synopsis: Available built-in builder classes. :synopsis: Available built-in builder classes.
@ -75,8 +76,8 @@ The builder's "name" must be given to the **-b** command-line option of
.. class:: QtHelpBuilder .. class:: QtHelpBuilder
This builder produces the same output as the standalone HTML builder, but This builder produces the same output as the standalone HTML builder, but
also generates `Qt help`_ collection support files that allow also generates `Qt help`_ collection support files that allow the Qt
the Qt collection generator to compile them. collection generator to compile them.
.. autoattribute:: name .. autoattribute:: name
@ -144,7 +145,8 @@ The builder's "name" must be given to the **-b** command-line option of
.. versionchanged:: 1.5 .. versionchanged:: 1.5
Since Sphinx-1.5, the epub3 builder is used for the default builder of epub. Since Sphinx-1.5, the epub3 builder is used for the default builder of
epub.
.. module:: sphinx.builders.latex .. module:: sphinx.builders.latex
.. class:: LaTeXBuilder .. class:: LaTeXBuilder
@ -159,12 +161,12 @@ The builder's "name" must be given to the **-b** command-line option of
in a "minimal" TeX distribution installation. For example, on Ubuntu, the in a "minimal" TeX distribution installation. For example, on Ubuntu, the
following packages need to be installed for successful PDF builds: following packages need to be installed for successful PDF builds:
* texlive-latex-recommended * ``texlive-latex-recommended``
* texlive-fonts-recommended * ``texlive-fonts-recommended``
* texlive-latex-extra * ``texlive-latex-extra``
* latexmk (for ``make latexpdf`` on GNU/Linux and MacOS X) * ``latexmk`` (for ``make latexpdf`` on GNU/Linux and MacOS X)
* latex-xcolor (old Ubuntu) * ``latex-xcolor`` (old Ubuntu)
* texlive-luatex, texlive-xetex (see :confval:`latex_engine`) * ``texlive-luatex``, ``texlive-xetex`` (see :confval:`latex_engine`)
The testing of Sphinx LaTeX is done on Ubuntu trusty with the above The testing of Sphinx LaTeX is done on Ubuntu trusty with the above
mentioned packages, which are from a TeXLive 2013 snapshot dated mentioned packages, which are from a TeXLive 2013 snapshot dated
@ -311,7 +313,6 @@ name is ``rinoh``. Refer to the `rinohtype manual`_ for details.
The filename for the search index Sphinx generates. The filename for the search index Sphinx generates.
See :ref:`serialization-details` for details about the output format. See :ref:`serialization-details` for details about the output format.
.. versionadded:: 0.5 .. versionadded:: 0.5