summaryrefslogtreecommitdiff
path: root/doc/markup
diff options
context:
space:
mode:
authorDavid Beitey <david@davidjb.com>2014-05-12 12:04:16 +1000
committerDavid Beitey <david@davidjb.com>2014-05-12 12:04:16 +1000
commitafaf12f28713c2813f483a311115023c9f8195d8 (patch)
treef97d7fe017769b0fbb83d146b0dd5df577dfa48c /doc/markup
parent27a52d9e8997994fe680bfab5b10e742942440e8 (diff)
downloadsphinx-afaf12f28713c2813f483a311115023c9f8195d8.tar.gz
Expand tag documentation to include syntax requirements
Diffstat (limited to 'doc/markup')
-rw-r--r--doc/markup/misc.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst
index b2e9051f..2b069601 100644
--- a/doc/markup/misc.rst
+++ b/doc/markup/misc.rst
@@ -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.