Kaydet (Commit) 437e6a3b authored tarafından Georg Brandl's avatar Georg Brandl

Move the glossary from the tutorial to toplevel.

Prepare for cross-linking with the new .. glossary:: directive.
üst 690b97c0
...@@ -14,6 +14,7 @@ ...@@ -14,6 +14,7 @@
install/index.rst install/index.rst
documenting/index.rst documenting/index.rst
howto/index.rst howto/index.rst
glossary.rst
about.rst about.rst
bugs.rst bugs.rst
......
...@@ -374,6 +374,20 @@ to objects: ...@@ -374,6 +374,20 @@ to objects:
The name of a grammar token (used in the reference manual to create links The name of a grammar token (used in the reference manual to create links
between production displays). between production displays).
The following role creates a cross-reference to the term in the glossary:
.. describe:: term
Reference to a term in the glossary. The glossary is created using the
``glossary`` directive containing a definition list with terms and
definitions. It does not have to be in the same file as the ``term``
markup, in fact, by default the Python docs have one global glossary
in the ``glossary.rst`` file.
If you use a term that's not explained in a glossary, you'll get a warning
during build.
--------- ---------
The following roles don't do anything special except formatting the text The following roles don't do anything special except formatting the text
......
This diff is collapsed.
This diff is collapsed.
...@@ -41,6 +41,8 @@ language's flavor and style. After reading it, you will be able to read and ...@@ -41,6 +41,8 @@ language's flavor and style. After reading it, you will be able to read and
write Python modules and programs, and you will be ready to learn more about the write Python modules and programs, and you will be ready to learn more about the
various Python library modules described in the Python Library Reference. various Python library modules described in the Python Library Reference.
The :ref:`glossary` is also worth going through.
.. toctree:: .. toctree::
appetite.rst appetite.rst
...@@ -57,4 +59,3 @@ various Python library modules described in the Python Library Reference. ...@@ -57,4 +59,3 @@ various Python library modules described in the Python Library Reference.
whatnow.rst whatnow.rst
interactive.rst interactive.rst
floatingpoint.rst floatingpoint.rst
glossary.rst
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment