Le générateur automatique de documentation
Une fonctionnalité annexe de l’admin
est le gestionnaire de documentation automatique. Bien qu’annexe,
cette fonctionnalité est très intéressante.
Django va parcourir toutes les applications
installées dans INSTALLED_APPS,
et en extraire la documentation en inspectant les documentations
(docstrings Python) des modèles, des vues et des tags/filtres
de templates. Cela va non seulement concerner votre code, de façon à fabriquer rapidement
une documentation claire, mais également le code de Django, vous
donnant accès à la description de nombreuses fonctionnalités,
notamment les tags et les filtres, directement sur votre site.
1. Installation
Prérequis
Le module Python docutils doit
avoir été installé au préalable
: http://docutils.sf.net/
Optionnelle, l’application django.contrib.admindocs.middleware.XView
Middleware doit être installée pour pouvoir
utiliser les « admindocs bookmarklets ».
Pour activer admindocs, ajoutez django.contrib.admindocs à INSTALLED_APPS dans votre
fichier settings.py.
Ajoutez la ligne suivante (ou décommentez-la)
dans le fichier urls.py racine :
(r’ˆadmin/doc/’, include(’django.contrib.admindocs.urls’))
Positionnez-la avant la ligne contenant l’entrée
r’ˆadmin/’, de façon à ce que les requêtes/admin/doc/ aillent
dans ...