diff options
Diffstat (limited to 'doc/markup/misc.rst')
| -rw-r--r-- | doc/markup/misc.rst | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index 5a391d02..fd31480a 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -52,16 +52,16 @@ Meta-information markup By default, this markup isn't reflected in the output in any way (it helps keep track of contributions), but you can set the configuration value - :confval:`show_authors` to True to make them produce a paragraph in the + :confval:`show_authors` to ``True`` to make them produce a paragraph in the output. .. rst:directive:: .. codeauthor:: name <email> - The :rst:dir:`codeauthor` directive, which can appear multiple times, names the - authors of the described code, just like :rst:dir:`sectionauthor` names the - author(s) of a piece of documentation. It too only produces output if the - :confval:`show_authors` configuration value is True. + The :rst:dir:`codeauthor` directive, which can appear multiple times, names + the authors of the described code, just like :rst:dir:`sectionauthor` names + the author(s) of a piece of documentation. It too only produces output if + the :confval:`show_authors` configuration value is ``True``. Index-generating markup @@ -189,6 +189,14 @@ Including content based on tags These standard tags are set *after* the configuration file is read, so they are not available there. + All tags must follow the standard Python identifier syntax as set out in + the `Identifiers and keywords + <https://docs.python.org/reference/lexical_analysis.html#identifiers>`_ + documentation. That is, a tag expression may only consist of tags that + conform to the syntax of Python variables. In ASCII, this consists of the + uppercase and lowercase letters ``A`` through ``Z``, the underscore ``_`` + and, except for the first character, the digits ``0`` through ``9``. + .. versionadded:: 0.6 .. versionchanged:: 1.2 Added the name of the builder and the prefixes. |