summaryrefslogtreecommitdiff
path: root/doc/markup
diff options
context:
space:
mode:
authorRoland Meister <Roland Meister@localhost>2013-06-06 21:23:16 +0200
committerRoland Meister <Roland Meister@localhost>2013-06-06 21:23:16 +0200
commitce6b8fff700cd9fa2e473e438d51aad705656fd2 (patch)
treee33b0130cc4bff897427a6c4dccab4fec5052a72 /doc/markup
parentf1e25afe259075988a1d5248968eb416b5e68d5c (diff)
downloadsphinx-git-ce6b8fff700cd9fa2e473e438d51aad705656fd2.tar.gz
Clarify docs for the format and builder tags
Diffstat (limited to 'doc/markup')
-rw-r--r--doc/markup/misc.rst13
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst
index d0ace3fa7..86b625dbc 100644
--- a/doc/markup/misc.rst
+++ b/doc/markup/misc.rst
@@ -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.