Sphinx
------
According to |the sphinx Git page|, Sphinx is a tool that makes it easy
to create intelligent and beautiful documentation for Python projects
(or other documents consisting of multiple |reStructuredText| sources).
It was originally created for the new Python documentation, but it
supports other languages.

Sphinx uses reStructuredText as its markup language, and many of its strengths
come from the power and straightforwardness of reStructuredText and its parsing
and translating suite, the Docutils.

Among its features are the following:

* Output formats: HTML (including derivative formats such as HTML Help, Epub
  and Qt Help), plain text, manual pages and LaTeX or direct PDF output
  using rst2pdf
* Extensive cross-references: semantic markup and automatic links
  for functions, classes, glossary terms and similar pieces of information
* Hierarchical structure: easy definition of a document tree, with automatic
  links to siblings, parents and children
* Automatic indices: general index as well as a module index
* Code handling: automatic highlighting using the Pygments highlighter
* Flexible HTML output using the Jinja 2 templating engine
* Various extensions are available, e.g. for automatic testing of snippets
  and inclusion of appropriately formatted docstrings
* Setuptools integration

.. |the sphinx Git page| raw:: html

   <a href="https://github.com/sphinx-doc/sphinx" target="_blank">the sphinx Git page</a>

.. |reStructuredText| raw:: html

   <a href="https://en.wikipedia.org/wiki/ReStructuredText" target="_blank">reStructuredText</a>


Read the Docs Sphinx Theme
--------------------------
|The sphinx_rtd_theme Git page| describes |Read the Docs Sphinx Theme|
as a theme for Sphinx that is designed to look modern and be mobile-friendly.
This theme is primarily focused to be used on |readthedocs.org| but can
work with other sphinx projects.

.. |The sphinx_rtd_theme Git page| raw:: html

   <a href="https://github.com/rtfd/sphinx_rtd_theme" target="_blank">The sphinx_rtd_theme Git page</a>

.. |Read the Docs Sphinx Theme| raw:: html

   <a href="https://sphinx-rtd-theme.readthedocs.io" target="_blank">Read the Docs Sphinx Theme</a>

.. |readthedocs.org| raw:: html

   <a href="readthedocs.org" target="_blank">readthedocs.org</a>

Resources
---------

**Sphinx and Read the Docs**

+ |Getting Started with Sphinx|
+ |Read the Docs Sphinx Theme|
+ |Read the Docs Theme Configuration|

**reStructuredText**

+ |Online Sphinx editor|
+ |Sphinx reStructuredText Syntax Guide|
+ |Sphinx’s reStructuredText primer|
+ |Read the Doc Demo: Paragraph Level Markup|
+ |Work with reStructured Text Content|

  * Good resource to understand linking
+ |Detailed reStructuredText and Sphinx example file|
+ |Restructured Text (reST) and Sphinx CheatSheet|
+ |Markdown and reStructuredText on GitHub|


.. |Getting Started with Sphinx| raw:: html

   <a href="https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html" target="_blank">Getting Started with Sphinx</a>

.. |Read the Docs Theme Configuration| raw:: html

   <a href="https://sphinx-rtd-theme.readthedocs.io/en/stable/" target="_blank">Read the Docs Theme Configuration</a>


.. |Online Sphinx editor| raw:: html

   <a href="https://livesphinx.herokuapp.com/" target="_blank">Online Sphinx editor</a>

.. |Sphinx reStructuredText Syntax Guide| raw:: html

   <a href="http://www.sphinx-doc.org/en/master/usage/restructuredtext" target="_blank">Sphinx reStructuredText Syntax Guide</a>

.. |Sphinx’s reStructuredText primer| raw:: html

   <a href="https://build-me-the-docs-please.readthedocs.io/en/latest/Using_Sphinx/OnReStructuredText.html" target="_blank">Sphinx’s reStructuredText primer</a>

.. |Read the Doc Demo: Paragraph Level Markup| raw:: html

   <a href="https://sphinx-rtd-theme.readthedocs.io/en/latest/demo/demo.html" target="_blank">Read the Doc Demo: Paragraph Level Markup</a>

.. |Work with reStructured Text Content| raw:: html

   <a href="https://sublime-and-sphinx-guide.readthedocs.io/en/latest/index.html" target="_blank">Work with reStructured Text Content</a>

.. |Detailed reStructuredText and Sphinx example file| raw:: html

   <a href="https://docs.anaconda.com/restructuredtext/detailed/" target="_blank">Detailed reStructuredText and Sphinx example file</a>

.. |Restructured Text (reST) and Sphinx CheatSheet| raw:: html

   <a href="https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html" target="_blank">Restructured Text (reST) and Sphinx CheatSheet</a>

.. |Markdown and reStructuredText on GitHub| raw:: html

   <a href="https://gist.github.com/dupuy/1855764" target="_blank">Markdown and reStructuredText on GitHub</a>