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

Clarify docs for the format and builder tags

Browse Source
This commit is contained in:
Roland Meister
2013-06-06 21:23:16 +02:00
parent f1e25afe25
commit ce6b8fff70
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/markup/misc.rst
View File

@@ -179,10 +179,11 @@ Including content based on tags
within :file:`conf.py`) are true. Boolean expressions, also using
parentheses (like ``html and (latex or draft)``) are supported.
The format and the name of the current builder (``html``, ``latex`` or
``text``) is always set as a tag [#]_. To make the distinction between
The *format* and the *name* of the current builder (``html``, ``latex`` or
``text``) are always set as a tag [#]_. To make the distinction between
format and name explicit, they are also added with the prefix ``format_`` and
``builder_``.
``builder_``, e.g. the epub builder defines the tags ``html``, ``epub``,
``format_html`` and ``builder_epub``.
.. versionadded:: 0.6
.. versionchanged:: 1.2
@@ -245,6 +246,6 @@ following directive exists:
.. rubric:: Footnotes
.. [#] At the moment only the epub builder distinguishes between the builder
format and the builder name.
.. [#] For most builders name and format are the same. At the moment only
builders derived from the html builder distinguish between the builder
format and the builder name.