Commits

Roland Meister  committed d1f7714

Clarify docs for the format and builder tags

  • Participants
  • Parent commits 228b5cf

Comments (0)

Files changed (1)

File doc/markup/misc.rst

    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
 
 .. 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.