Cette documentation est écrite avec le language de balisage léger reStructuredText. Puis les versions HTML et LaTeX sont obtenues via le générateur de documentation Sphinx.
Chaque fois que la documentation est mise à jour sur GitHub elle est automatiquement transformée en :
Que ce soit pour corriger une simple coquille, une petite imprécision, ou pour écrire une nouvelle section dans la documentation, votre aide est précieuse.
Vous pouvez comme au bon vieux temps simplement envoyer un e-mail à l'une des personnes impliquées dans le projet en lui indiquant la modification à faire.
Plusieurs méthodes se présentent en fonction de votre niveau d'implication et/ou de compétence :
- Vous pouvez ouvrir un ticket Issue qui décrit le problème.
- Vous pouvez directement éditer le fichier incriminé à partir de l'interface web de GitHub.
- Vous pouvez cloner ce dépôt, modifier les fichier en local, puis faire un push ou pull request (selon vos droits).
Note
Pour obtenir des droits en écriture directe, il suffit de les demander à l'un des propriétaires.
La première version de cette documentation à été créée par Omar Aouadi.
La première version sous reStructuredText a été obtenue par Kroum Tzanev en utilisant Pandoc.
La liste des contributeurs dans l'ordre chronologique :
- Omar Aouadi
- Kroum Tzanev
- Jean-François Burnol