Skip to content

Commit

Permalink
Merged in westurner/sphinx/westurner/doc-glossary-markup-ref (pull re…
Browse files Browse the repository at this point in the history
…quest sphinx-doc#310)

DOC: Add reference to markup/para.rst#glossary-directive from markup/inline.rst
  • Loading branch information
birkenfeld committed Oct 18, 2014
2 parents 215c4c0 + 5fb0c37 commit e2a5298
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/markup/inline.rst
Expand Up @@ -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``
Expand Down
2 changes: 2 additions & 0 deletions doc/markup/para.rst
Expand Up @@ -148,6 +148,8 @@ For local tables of contents, use the standard reST :dudir:`contents directive
<table-of-contents>`.


.. _glossary-directive:

Glossary
--------

Expand Down

0 comments on commit e2a5298

Please sign in to comment.