summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRoland Meister <devnull@localhost>2013-04-25 23:08:30 +0200
committerRoland Meister <devnull@localhost>2013-04-25 23:08:30 +0200
commit211e9e27bbfd933a7fdc06db7f87c1d9572939fa (patch)
tree5dce6954a69c898bec6bcda47cf9b22ac0c32451 /doc
parent1d963f7e655d45975362b7e4fec1878537970301 (diff)
downloadsphinx-211e9e27bbfd933a7fdc06db7f87c1d9572939fa.tar.gz
Add the builder name as predefined tag for the only directive.
At the moment only the epub builder distinguishes between format and name. Explicit entries with format_ and builder_ prefix are also added.
Diffstat (limited to 'doc')
-rw-r--r--doc/markup/misc.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst
index f5eaac9c..d0ace3fa 100644
--- a/doc/markup/misc.rst
+++ b/doc/markup/misc.rst
@@ -179,10 +179,14 @@ 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 of the current builder (``html``, ``latex`` or ``text``) is always
- set as a tag.
+ The format and the name of the current builder (``html``, ``latex`` or
+ ``text``) is always set as a tag [#]_. To make the distinction between
+ format and name explicit, they are also added with the prefix ``format_`` and
+ ``builder_``.
.. versionadded:: 0.6
+ .. versionchanged:: 1.2
+ Added the name of the builder and the prefixes.
Tables
@@ -238,3 +242,9 @@ following directive exists:
means that by default, Sphinx generates such column specs for such tables.
Use the :rst:dir:`tabularcolumns` directive to get finer control over such
tables.
+
+.. rubric:: Footnotes
+
+.. [#] At the moment only the epub builder distinguishes between the builder
+ format and the builder name.
+