summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-10-18 09:02:18 +0200
committerGeorg Brandl <georg@python.org>2014-10-18 09:02:18 +0200
commit6672f1d3acda9f1d45b802a898aa698cf903fa64 (patch)
tree220627532e789aad06cae9300bccef4348809e76
parente7e402c67829bc9ef1756a6f5f7ad1b7794d3ee7 (diff)
parent3e20a1de3e393055d5d19637538ad99593c2b1cc (diff)
downloadsphinx-6672f1d3acda9f1d45b802a898aa698cf903fa64.tar.gz
Merged in westurner/sphinx/westurner/doc-glossary-markup-ref (pull request #310)
DOC: Add reference to markup/para.rst#glossary-directive from markup/inline.rst
-rw-r--r--doc/markup/inline.rst5
-rw-r--r--doc/markup/para.rst2
2 files changed, 5 insertions, 2 deletions
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst
index 6f3ebe1c..76c1a5b0 100644
--- a/doc/markup/inline.rst
+++ b/doc/markup/inline.rst
@@ -247,11 +247,12 @@ objects:
exists.
-The following role creates a cross-reference to the term in the glossary:
+The following role creates a cross-reference to a term in a
+:ref:`glossary <glossary-directive>`:
.. rst:role:: term
- Reference to a term in the glossary. The glossary is created using the
+ Reference to a term in a glossary. A 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,
for example the Python docs have one global glossary in the ``glossary.rst``
diff --git a/doc/markup/para.rst b/doc/markup/para.rst
index c6a49b15..cc03a9f1 100644
--- a/doc/markup/para.rst
+++ b/doc/markup/para.rst
@@ -148,6 +148,8 @@ For local tables of contents, use the standard reST :dudir:`contents directive
<table-of-contents>`.
+.. _glossary-directive:
+
Glossary
--------