Page 1 sur 1

Doc WAPT

Publié : 21 avr. 2017 - 10:39
par OtOMatick
Bonjour,
Votre documentation est très bien faite! https://www.wapt.fr/fr/doc/
Pourriez-vous m'indiquer ce qu'il faut pour mettre en place le même genre d'outil chez mon client?
J'ai à ma disposition un serveur CentOS 7, et voudrait pouvoir présenter à mon client ce genre de doc.
C'est clair, simple et très bien fait!

Merci de votre retour.

Re: Doc WAPT

Publié : 21 avr. 2017 - 10:54
par agauvrit
Bonjour,

Tout d'abord merci au nom de Tranquil IT Systems, ça fait toujours plaisir de recevoir des compliments, toute l'équipe s'attache à fournir une documentation aussi complète que possible.

Pour ce qui est de la documentation en elle-même, nous générons la documentation en utilisant reStructuredText / Docutils / Sphinx.

Si vous avez déjà édité du markdown/wiki c'est assez semblable dans l'organisation des titres, la grosse différence est la compilation de la documentation, cela nous permet de générer la documentation en différentes langues et en différents formats (HTML/PDF/ePub/Latex).

Si vous souhaitez découvrir RST/Sphinx/Docutils : https://www.jujens.eu/posts/2014/Aug/13 ... st-sphinx/

La documentation officielle : http://docutils.sourceforge.net/sandbox ... rt-fr.html

Alexandre

Re: Doc WAPT

Publié : 21 avr. 2017 - 14:52
par OtOMatick
Merci, j'ai obtenu le résultat que je voulais. ;)
Maintenant, je vais chercher comment faire la même chose, mais à la main, car les yum install et pip install ne me conviennent pas.

Je préfère garder la main sur ce que j'installe, pour installer ce que je veux où je veux. (donc partir des tar.gz).

(Vous n'avez pas par hasard une doc de comment installer tout ça depuis les sources sous CentOS?)
((Voir encore mieux! Un package tout prêt, configurable, incluant tout ce qu'il faut sans dépendances))
(((Tiens, vous ne faites pas ça pour vos clients? Distribuer via wapt ce genre de Wiki sur les postes clients pour leur informations internes. Peu doivent avoir des intranets ou des wikis.)))

Re: Doc WAPT

Publié : 21 avr. 2017 - 17:15
par agauvrit
Pour l'installation from scratch il n'y a pas tellement de documentation à vrai dire, hormis le fichier setup.py du projet sphinx : https://github.com/sphinx-doc/sphinx/bl ... r/setup.py

Nous ne l'utilisons pas sous Windows, le bot de compilation de la documentation depuis le repo Git (Jenkins) utilise les commandes pip pour l'installation des dépendances.

Bon courage avec RST en tout cas ;)