doc: Add "builders" to usage guide

This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane committed 2018-06-20 09:26:59 +01:00
1 parent 7e27e09493
commit b595c4a45b
5 files changed
+7 -6

No files matched your search

+1 -1
View File
@@ -12,10 +12,10 @@ Sphinx documentation contents
usage/restructuredtext/index
usage/markdown
usage/configuration
usage/builders/index
intro
man/index
builders
intl
theming
setuptools
+2 -1
View File
@@ -12,7 +12,8 @@ Glossary
use the builder builders that e.g. check for broken links in the
documentation, or build coverage information.
See :ref:`builders` for an overview over Sphinx's built-in builders.
See :doc:`/usage/builders/index` for an overview over Sphinx's built-in
builders.
configuration directory
The directory containing :file:`conf.py`. By default, this is the same as
+3 -3
View File
@@ -86,8 +86,8 @@ Options
Build compact pretty-printed "pseudo-XML" files displaying the
internal structure of the intermediate document trees.
See :ref:`builders` for a list of all builders shipped with Sphinx.
Extensions can add their own builders.
See :doc:`/usage/builders/index` for a list of all builders shipped with
Sphinx. Extensions can add their own builders.
.. _make_mode:
@@ -96,7 +96,7 @@ Options
Alternative to :option:`-b`. Uses the Sphinx :program:`make_mode` module,
which provides the same build functionality as a default :ref:`Makefile or
Make.bat <makefile_options>`. In addition to all Sphinx
:ref:`builders <builders>`, the following build pipelines are available:
:doc:`/usage/builders/index`, the following build pipelines are available:
**latexpdf**
Build LaTeX files and run them through :program:`pdflatex`, or as per
File renamed without changes.
+1 -1
View File
@@ -444,7 +444,7 @@ candidates. For instance, if the file name ``gnu.*`` was given and two files
:file:`gnu.pdf` and :file:`gnu.png` existed in the source tree, the LaTeX
builder would choose the former, while the HTML builder would prefer the
latter. Supported image types and choosing priority are defined at
:ref:`builders`.
:doc:`/usage/builders/index`.
Note that image file names should not contain spaces.