Documentation de la documentation¶

La documentation de pythoneon est écrite en rst ou reStructuredText ; les fichiers source se trouvent dans ~/pythoneon/Documentation/source.

Pour compiler la documentation il faut aller dans ~/pythoneon/Documentation où il faut lancer $ make html; le résultat se trouvera dans ~/pythoneon/Documentation/build/html.

Des exemples de rst ? voir:

http://sphinx-doc.org/rest.html

et aussi la doc qui vient avec le langage Python en général dans un répertoire Doc.

Le format d’écriture RST permet beaucoup de conversions:

rst-buildhtml     - convert many reST documents to HTML
rst2html          - convert reST documents to XHTML
rst2latex         - convert reST documents to LaTeX
rst2man           - generate unix manpages from reStructured text
rst2odt           - convert reST documents to OpenDocument text (ODT)
rst2pseudoxml     - convert reST documents to pseudo-XML
rst2s5            - convert reST documents to S5 slides
rst2xetex         - convert reST documents to XeLaTeX
rst2xml           - convert reST documents to XML

mais la plupart ne dispose pas de toutes les extensions de Sphinx.

Ajustements¶

Les couleurs utilisées dans les pages de texte et les fontes sont réglées par les feuilles de style: basic.css, default.css et pygments.css. Il est possible de changer les données dans ces feuilles de style; ces changements se répercutent sur toutes les pages.

Écrire sa propre documentation¶

Enfin, je conseille à chacun d’écrire la documentation des pythons personnels:

elle permet de s’y retrouver plus facilement,
cela donne des idées pour l’amélioration de l’existant et l’exploration de nouveaux domaines.

Documentation officielle de RST¶

La doc officielle de RST se trouve:

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html

mais elle presque nécessairement cunaire, il faut s’informer sur le web.