2019-02-28 18:09:55 +00:00
|
|
|
Glossary
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
.. glossary::
|
|
|
|
|
|
2019-02-28 18:23:48 +00:00
|
|
|
`Sphinx`_
|
2019-02-28 18:09:55 +00:00
|
|
|
|
2019-02-28 18:23:48 +00:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
`reStructuredText`_
|
|
|
|
|
|
|
|
|
|
Is an easy-to-read, what-you-see-is-what-you-get plaintext
|
|
|
|
|
markup syntax and parser system.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _Sphinx: https://www.sphinx-doc.org
|
|
|
|
|
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
|
