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: | 2018-5-3 |
---|
See also
- 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
- Sphinx
conf.py
Examples- sphinx markup
- sphinx domain
- sphinx code
- toctree
- Paragraphs
- Image
- figure
- kfigure : Scalable figure and image handling (needs linuxdoc extension, 2016-2017)
- Substitution
- Lists
- Source Code
- include
- code-block (pygments, highlight)
- rest Tables
- sphinx Hyperlinks
- Sphinx Sections
- Explicit Markup
- Sphinx Directives
- Sphinx Footnotes
- Comments
- Source encoding
- sidebar
- Gotchas