How to build documentation with Sphinx
=========================================

What is Sphinx?
+++++++++++++++++
From Sphinx Homepage:

   `Sphinx <https://www.sphinx-doc.org/en/master/>`_ is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

   It was originally created for the Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx! The following features should be highlighted:

      * Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text
      * Extensive cross-references: semantic markup and automatic links for functions, classes, citations, 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 language-specific module indices
      * Code handling: automatic highlighting using the `Pygments <http://pygments.org/>`_ highlighter
      * Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and `more <https://www.sphinx-doc.org/en/master/ext/builtins.html#builtin-sphinx-extensions>`_
      * Contributed extensions: more than 50 extensions `contributed by users <https://www.sphinx-doc.org/en/master/develop.html#extensions>`_ in a second repository; most of them installable from PyPI



.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart
   demo
   install
   reposetup
   website
   githubpages
   theme
   docstring
   addtoindx
   api
   markdown
   mymarkdown
   math
   books
   resources






Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`