IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Expand tag documentation to include syntax requirements

Browse Source
This commit is contained in:
David Bernard
2014-05-12 12:04:16 +10:00
parent 78af1cb5d3
commit 7f78995d06
2 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@@ -142,6 +142,7 @@ Bugs fixed
Documentation Documentation
------------- -------------
* Add clarification about the syntax of tags. (:file:`doc/markup/misc.rst`)
* #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`) * #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`)
* Extended the :ref:`documentation about building extensions <dev-extensions>`. * Extended the :ref:`documentation about building extensions <dev-extensions>`.

8
doc/markup/misc.rst
View File

@@ -189,6 +189,14 @@ Including content based on tags
These standard tags are set *after* the configuration file is read, so they These standard tags are set *after* the configuration file is read, so they
are not available there. 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 .. versionadded:: 0.6
.. versionchanged:: 1.2 .. versionchanged:: 1.2
Added the name of the builder and the prefixes. Added the name of the builder and the prefixes.