Le format pour la documentation : le format ReST (reStructuredText)

Voir aussi

• http://docutils.sourceforge.net/rst.html

• http://www.sphinx-doc.org/en/stable/rest.html

• https://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html

• https://pvbookmarks.readthedocs.io/en/master/documentation/doc_generators/sphinx/sphinx.html#rest-sphinx

Sommaire

• Le format pour la documentation : le format ReST (reStructuredText)

  • Description

  • Exemple

Description

reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system.

It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents.

reStructuredText is designed for extensibility for specific application domains.

The reStructuredText parser is a component of Docutils. reStructuredText is a revision and reinterpretation of the StructuredText and Setext lightweight markup systems.

Exemple

La page que vous lisez a été réalisé avec sphinx. Cliquer sur le bouton “Montrer le code source” pour voir le code ReST (reStructuredText)