Auto-documentation sur code.spip.net

En complément à ce site https://programmer.spip.net, à la documentation de spip.net et à celles des plugins sur contrib.spip.net, le site https://code.spip.net fourni une documentation du code de spip et de certains plugins, générée de manière automatisée à partir des commentaires phpDoc trouvés dans le source. Pour cela, le site utilise phpDocumentor 3 et l’outil Autodoc.

Cette auto-documentation porte sur SPIP et sur les plugins déclarés dans la liste autodoc.txt. Ces plugins sont triés selon l’organisation (Plugins, Squelettes, Outils) dont ils font partie sur le repo git de SPIP. Les plugins qui sont encore dans l’organisation Core mais qui ont été retirés de la dist figurent aussi avec les Plugins. Si l’organisation d’un plugin ne peut être déterminée, sa doc sera rangé dans Autres, ou dans Externe dans le cas d’un dépot git externe.

Par ailleurs, s’il existe un fichier docs/index.rst ou doc/index.rst dans le source documenté, alors cette documentation sera aussi générée, et sa table des matières sera visible en colonne (entre les Links et les Packages ou Namespaces). Il n’y a encore aucun exemple dans les plugins SPIP, mais ça peut être intéressant à fournir.

Auteur JLuc, Matthieu Marcillaud Publié le : Mis à jour : 09/01/22