mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-13 08:52:13 -05:00
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
This commit is contained in:
commit
e2a5298f1f
2 files changed
+5
-2
No files matched your search
@@ -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``
|
||||
|
||||
@@ -148,6 +148,8 @@ For local tables of contents, use the standard reST :dudir:`contents directive
|
||||
<table-of-contents>`.
|
||||
|
||||
|
||||
.. _glossary-directive:
|
||||
|
||||
Glossary
|
||||
--------
|
||||
|
||||
|
||||
Reference in new issue
Block a user