Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example to glossary definition and fix some typos #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add example to glossary definition and fix some typos #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions source/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Add a Glossary
Add a Glossary
###################

Sphinx has a built-in Glossary structure that you can use to:
Expand All @@ -11,21 +11,24 @@ Create a Glossary
******************

To add glossary terms, you use the directive ``.. glossary::``. Write each
glossary entry as a definition list, with a term, followed by a single-line
indented definition.
glossary entry as a definition list, with a term, followed by an indented single or multiple line definition.

Each glossary entry is nested below the ``.. Glossary::`` directive. For
Each glossary entry is nested below the ``.. glossary::`` directive. For
example:

.. code-block:: RST

.. glossary::
Sphinx
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages.

Sphinx
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages.

RST
|RST| is an easy-to-read, what-you-see-is-what-you-get plain text markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. |RST| is designed for extensibility for specific application domains. The |RST| parser is a component of Docutils.
|RST| is an easy-to-read, what-you-see-is-what-you-get plain text markup syntax and parser system.
It is useful for in-line program documentation (such as Python docstrings),
for quickly creating simple web pages, and for standalone documents.
|RST| is designed for extensibility for specific application domains.
The |RST| parser is a component of Docutils.

Sublime Text
Sublime Text is a sophisticated text editor for code, markup and prose. You'll love the slick user interface, extraordinary features and amazing performance.
Expand Down