.. index::
   ! Sphinx
   pair: Documentation ; Sphinx

.. _documenting_with_sphinx:
.. _sphinx:

===================================
Sphinx 
===================================

.. seealso::

   - https://github.com/sphinx-doc/sphinx
   - https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)
   - https://github.com/yoloseem/awesome-sphinxdoc
   - http://sphinx-doc.org/
   - http://sphinx-doc.org/latest/
   - http://sphinx-doc.org/examples.html
   - http://rest-sphinx-memo.readthedocs.org/en/latest/Project.html
   - http://rest-sphinx-memo.readthedocs.org/en/latest/References.html
   - http://redaction-technique.org/index.html


.. figure:: sphinx.png
   :align: center

   *Sphinx logo*

.. contents:: :local:


Description
============

**Sphinx** 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 new Python documentation, and it has excellent 
facilities for the documentation of Python projects, but C/C++ is already 
supported as well, and it is planned to add special support for other languages 
as well.


Sphinx source code (Sphinx dev guide)
=====================================

.. seealso:: 

   - https://github.com/sphinx-doc/sphinx


.. toctree::
   :maxdepth: 5

   development/development


Sphinx applications
===================

.. toctree::
   :maxdepth: 4

   applications/applications


reST Sphinx
============

.. toctree::
   :maxdepth: 5

   rest_sphinx/rest_sphinx
  
Sphinx extensions and contributed extensions
============================================

.. toctree::
   :maxdepth: 4
  
   extensions/extensions      
   contributed_extensions/contributed_extensions 
   

Sphinx howto
===================

.. toctree::
   :maxdepth: 4

   howto/howto
   
   
Hébergeurs Sphinx 
========================

.. toctree::
   :maxdepth: 4

   hebergeurs/hebergeurs
   
 
Sphinx examples
=====================

.. toctree::
   :maxdepth: 4

   examples/examples
   references 
   
Sphinx i18n
===================

.. toctree::
   :maxdepth: 4

   i18n/i18n

Sphinx installation
===================

.. toctree::
   :maxdepth: 4

   install/install

Sphinx people
===================

.. toctree::
   :maxdepth: 4

   people/people


Sphinx tutorials
===================

.. toctree::
   :maxdepth: 4

   tutorials/tutorials


Tools for Sphinx
===================

.. toctree::
   :maxdepth: 4

   tools_for_sphinx/index


Sphinx themes
===================

.. toctree::
   :maxdepth: 4

   themes/themes


Sphinx templating
===================

.. toctree::
   :maxdepth: 4

   templating/templating


Sphinx translations
===================

.. toctree::
   :maxdepth: 4

   translations/translations

Sphinx versions
===================

.. toctree::
   :maxdepth: 4

   versions/versions