Documentation, je t'aime je te hais

Rédigé par jeromef aucun commentaire


10 décembre 2013 Python, Raspython, tutoriel aucun


Parcequ'elle est toujours considérée comme une perte de temps au début et qu'on peste (au bas mot) à la fin du projet, ou longtemps après de ne pas l'avoir faite, pourquoi ne pas envisager des outils qui la constitue (presque) automatiquement ?... j'ai nommé la documentation !
Pour vous, rien que pour vous, je vous fait découvrir comment générer une doc automatiquement pour vos projets python : Python-sphinx

Pas grand chose encore en ligne, vu que j'ai fait pas mal de changements après avoir installé Sphinx, et bientot un lien portera la doc du Projet APiClock 


installer sphinx

easy_install -U Sphinx
Lancer la config automatique :
sphinx-quickstart
Puis répondre aux questions (par défaut tout marche mais intéressant de customiser si besoin) Enfin se rendre dans le dossier que l'on a cité en tant que root de la documentation et:
make html

Pour customiser le thème par défaut:
(et avoir quelquechose qui peut ressembler à la doc de virtualenv) :
pip install sphinx_rtd_theme
Puis dans le conf.py (racine du foot de la doc), rajouter en haut :
import sphinx_rtd_theme
,rechercher la ligne commençant par : "html_theme… " et changer par
html_theme = "sphinx_rtd_theme"
et enfin rechercher la ligne commençant par : "html_theme_path =… " et changer par :
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

puis aller dans le foot de la doc et dans le rep "./_build/html" et ouvrir le fichier index.html

Et vous vous faites comment ?


Pour en savoir plus



Partager cet article sur :


Écrire un commentaire

Quelle est la troisième lettre du mot vwtpz ? :