L’application admindocs de Django récupère la documentation depuis les chaînes de documentation « docstrings » des modèles, des vues, des balises de gabarit et des filtres de gabarit de toutes les applications figurant dans INSTALLED_APPS et rend cette documentation disponible à partir de l'administration de Django.
Pour activer admindocs, voici ce qu’il faut faire :
Ajoutez admindocs au réglage INSTALLED_APPS.
Ajoutez url(r'^admin/doc/', include('django.contrib.admindocs.urls')) aux motifs d’URL urlpatterns. Assurez-vous que cette inclusion apparaisse avant la ligne r'^admin/', de sorte que les requêtes vers /admin/doc/ ne soient pas interceptées par cette dernière.
Installez le module Python docutils (http://docutils.sf.net/).
Facultatif : l’utilisation des signets dynamiques d’admindocs nécessite que django.contrib.admindocs.middleware.XViewMiddleware soit installé.
Une fois ces étapes terminées, vous pouvez parcourir la documentation en allant sur l’interface d’administration et en cliquant sur le lien « Documentation » dans le coin supérieur droit de la page.
\nLe balisage spécial suivant peut être utilisé dans vos chaînes de documentation « docstrings » afin de créer facilement des liens vers d’autres composants :
\nComposant Django | \nRôles reStructuredText | \n
|---|---|
Modèles | \n
| \n
Vues | \n
| \n
Balises de gabarit | \n
| \n
Filtres de gabarit | \n
| \n
Gabarits | \n
| \n
La section modèles de la page d”admindocs décrit chaque modèle du système avec tous les champs et les méthodes disponibles. Les relations avec les autres modèles apparaissent sous forme d’hyperliens. Les descriptions sont récupérées des attributs help_text pour les champs ou des chaîne de documentation « docstrings » pour les méthodes de modèle.
Un modèle avec une documentation utile pourrait ressembler à ceci :
\nclass BlogEntry(models.Model):\n """\n Stores a single blog entry, related to :model:`blog.Blog` and\n :model:`auth.User`.\n """\n slug = models.SlugField(help_text="A short label, generally used in URLs.")\n author = models.ForeignKey(\n User,\n models.SET_NULL,\n blank=True, null=True,\n )\n blog = models.ForeignKey(Blog, models.CASCADE)\n ...\n\n def publish(self):\n """Makes the blog entry live on the site."""\n ...\nChaque URL de votre site possède une entrée séparée dans les pages admindocs; un clic sur une URL donnée montre la vue correspondante. Voici quelques exemples de choses utiles que vous pouvez documenter dans les chaînes de documentation « docstrings » de vos fonctions de vue :
Une brève description de ce que la vue réalise.
Le contexte ou une liste de variables disponibles dans le gabarit de la vue.
Le nom du ou des gabarits utilisés pour cette vue.
Par exemple :
\nfrom django.shortcuts import render\n\nfrom myapp.models import MyModel\n\ndef my_view(request, slug):\n """\n Display an individual :model:`myapp.MyModel`.\n\n **Context**\n\n ``mymodel``\n An instance of :model:`myapp.MyModel`.\n\n **Template:**\n\n :template:`myapp/my_template.html`\n """\n context = {'mymodel': MyModel.objects.get(slug=slug)}\n return render(request, 'myapp/my_template.html', context)\nBien qu”admindocs n’offre aucun moyen de documenter les gabarits eux-mêmes, si vous utilisez la syntaxe :template:`chemin/vers/gabarit.html` dans une chaîne « docstring », la page résultante vérifiera le chemin de ce gabarit avec le moteur de chargement des gabarits de Django. Cela peut être un moyen pratique pour vérifier si le gabarit existe et de montrer où ce gabarit est stocké dans le système de fichiers.
Un signet dynamique est disponible depuis la page admindocs:
Vous renvoie depuis n’importe quelle page vers la documentation de la vue qui génère cette page.
\nL’utilisation de ce signet dynamique nécessite que XViewMiddleware soit installé et que vous soyez connecté à l'administration de Django en tant que User avec is_staff contenant True.