This documentation is free ; you can edit, enhance and modify it as you want.
To start contribute, the simplest way is to start imitating documentation as it already exists.
You’ll find below some rules and the most common markup used in this documentation.
Lists
* first * second * third
- first
- second
- third
Titles and Sub-Titles
H1 -- Titre =========== H2 -- Sub titre --------------- H3 -- Sub section ****************** H4 -- Sub sub section ^^^^^^^^^^^^^^^^^^^^^ H5 ~~~~~~~~~~~~~~~~~~~~~~~Images
.. figure:: ../images/gplv3.png :align: center :alt: GPLv3 logo License GNU GPL v3
Image Caption
Bold / Italic
**bold** et *italic*bold et italic
External link
`example dot com`_ .. _example dot com: http://www.example.com/Note
You should reference links at the bottom of the page.
Internal link
:doc:`These rules <DocumentationGuidelines>`Glossary link
:term:`record`
Notes:
.. note:: A noteNote
A note
Warning:
.. warning:: Un warningWarning
Un warning
Version added
.. versionadded:: 3.5.0New in version 3.5.0.
Version changed
.. versionchanged:: 3.5.0Changed in version 3.5.0.
References
.. seealso:: online documentation at https://www.sphinx-doc.org/en/master/See also
online documentation at https://www.sphinx-doc.org/en/master/
Topic
.. topic:: Topic Title (for example: The essential)Subsequent indented lines comprise the body of the topic, and are interpreted as body elements.
Topic Title (for example: The essential)
Subsequent indented lines comprise the body of the topic, and are interpreted as body elements.