Demandez le programme! Documentation de codes avec Sphinx [06-06-2024]
lundi 27 mai 2024
Making a Python Package [Vincent]
lundi 7 juin 2021
« Comment créer un paquet Python et tout ce qui gravite autour: la documentation, les tests unitaires, les jeux de données, le déploiement, ... »
[python, package, tests, documentation]
LearningDoxygen [Vincent]
jeudi 5 septembre 2019
« Un wiki avec plein d'exemples (souvent plus parlant que dans la documentation officielle) pour utiliser le générateur de documentation Doxygen. »
[doxygen, c++, documentation]
5 Things You Can Do With a Locally Cloned GitHub Wiki [Vincent]
mercredi 28 novembre 2018
« Le wiki d'un projet GitHub (ou GitLab) est vu comme un dépôt Git. Voici comment le cloner, l'éditer ou le visualiser hors ligne avec Gollum, en faire une documentation html avec Pandoc, y ajouter des images, ou encore créer une table des matières. »
[gitlab, github, git, documentation]
VimDoxSpell = Vim + Doxygen + spell checking done right [Vincent]
mercredi 31 mai 2017
« Ce petit utilitaire permet d'utiliser le correcteur orthographique sur les commentaires de code pour Doxygen. Il reconnaît les balises Doxygen et souligne en rouge dans Vim les erreurs. »
[éditeur, outils, documentation]
Welcome to Stack Overflow Documentation [Alexandre]
jeudi 2 mars 2017
« Stackoverflow vient de lancer une page de documentation en mode participatif à destination des développeurs. »
[documentation]
Breathe [Alexandre]
vendredi 11 mars 2016
« Un outil sympa de génération de documentation faisant le pont entre Sphinx et Doxygen (plutôt orienté C/C++). »
[documentation, c++, python]
Library authors: Don't forget the examples! [Maxence]
vendredi 5 février 2016
« De l'importance d'inclure des examples d'utilisation quand on développe une bibliothèque. »
[documentation]
Utiliser BibTEX [Vincent]
vendredi 6 novembre 2015
« Un petit résumé de comment marche BiBTex sous LaTeX. Ce cours est aussi utile pour rédiger une bibliographie sous Doxygen, par exemple »
[latex, documentation]