Je me sers de Libdoc régulièrement pour générer la documentation des librairies de test que je développe, car aujourd’hui, la documentation est devenu un passage obligé pour tout projet qui se respecte.

C’est en effet très pratique pour les utilisateurs qui ne seront pas obligés d’aller dans le code pour voir les keywords proposés par la librairie 📖

Comment cela fonctionne ?

1️⃣ Documenter son code avec un certain formatage

Oui je ne parle pas là de génération “automatique” de documentation. Il faudra donc en écrire une 😊 avec un formatage particulier mais simple.

Il existe plusieurs formats (robot, html, text et reStructuredText) mais lorsque je développe mes keywords en Python, je choisis le format “reStructuredText”. Ce format est compatible avec un autre outil Sphinx qui permet lui de générer la doc Python d’une librairie). Comme ça je peux générer la doc Sphinx pour le même prix.

🔵La documentation doit être mise dans la Docstring pour Python ou dans la section [Documentation] pour les keywords Robot.

🔵 Un exemple ici de code de documentation au format “robot” dans des keywords Python :