.. highlightlang:: rest

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



.. _restructered_text_primer:
.. _rest_sphinx:

======================================
reStructuredText Sphinx documentation
======================================

This section is a brief introduction to reStructuredText (reST) concepts
and syntax, intended to provide authors with enough information to
author documents productively.

Since reST was designed to be a simple, unobtrusive markup language,
this will not take too long.


:Date: |today|

.. seealso::

   - http://sphinx-doc.org/latest/index.html
   - http://packages.python.org/an_example_pypi_project/sphinx.html
   - http://docutils.sourceforge.net/rst.html
   - http://rest-sphinx-memo.readthedocs.org/en/latest/ReST.html
   - http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/_sources/source/sphinx/rest_syntax.txt
   - http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
   - https://cjolowicz.github.io/posts/hypermodern-python-05-documentation/#writing-documentation-using-restructuredtext

   - :ref:`sphinx`


.. toctree::
   :maxdepth: 5

   conf.py/conf.py
   markup/markup
   domain/domain
   code/code
   toctree
   paragraphs
   image/image
   figure/figure
   substitution/substitution
   quotes
   source_code
   include
   code_block
   tables/tables
   hyperlinks
   sections
   explicit_markup
   directives
   footnotes
   comments
   source_encoding
   sidebar
   gotchas