Documentation Sphinx

Si vous utilisez Sphinx (par exemple) pour générer la documentation de vos projets, je vous conseil d’utiliser Read the Docs. Ce service permet de générer des documentations (HTML, PDF, EPUB, etc.) pour les projets utilisants des DVCS (Hg, Git, Bazaar, etc.) et qui comprennent les sources de leur documentation. En gros c’est comme si un service Web soccupait de générer vos .tex (hébergés sur un dépôt Git ou Mercurial) en PDF.

Je viens de tester avec la documentation de Stegano. Voici la documentation au format PDF. Le résultat est aussi plutôt sympa pour la documentation dIP-Link. Je pourrais aussi héberger la documentation sur mon serveur. Mais avec ce service l’avantage est que je n’ai qu’à modifier les sources de la documentation (fichiers *.rst) et de faire un push sur le dépôt, ici Bitbucket. Ensuite le service Read the Docs soccupe de générer la documentation.

Related Posts