summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTakayuki Shimizukawa <shimizukawa+bitbucket@gmail.com>2014-10-22 00:24:48 +0900
committerTakayuki Shimizukawa <shimizukawa+bitbucket@gmail.com>2014-10-22 00:24:48 +0900
commit48e972351bceaab7e0ef68a1042e3906d921d1a2 (patch)
tree46b7192f835f80c53b0cd5c83e5d75c1cc1c6ce2 /doc
parent540d1dabd9552589712023f3eb5c2ea2026fc7f9 (diff)
parentd29b10af8a746980b794516bf7adf4074fe7284e (diff)
downloadsphinx-48e972351bceaab7e0ef68a1042e3906d921d1a2.tar.gz
Merged in westurner/sphinx-1/westurner/doc-invocationrst-sphinxapidoc-m-option-1413253549167 (pull request #308)
DOC: invocation.rst: sphinx-apidoc -M option
Diffstat (limited to 'doc')
-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
--------