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

DOC: Add reference to markup/para.rst#glossary-directive from markup/inline.rst

Browse Source
This commit is contained in:
Wes Turner 2014-10-18 01:59:13 -05:00
parent 215c4c01c8
commit 5fb0c374e9
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/markup/inline.rst
View File

@ -247,11 +247,12 @@ objects:
exists. 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 .. 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 ``glossary`` directive containing a definition list with terms and
definitions. It does not have to be in the same file as the ``term`` markup, 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`` for example the Python docs have one global glossary in the ``glossary.rst``

2
doc/markup/para.rst
View File

@ -148,6 +148,8 @@ For local tables of contents, use the standard reST :dudir:`contents directive
<table-of-contents>`. <table-of-contents>`.
.. _glossary-directive:
Glossary Glossary
-------- --------