Nous attribuons une grande importance à la cohérence et à la lisibilité de la documentation. Après tout, Django a été créé dans un environnement journalistique ! Nous traitons donc la documentation sur un pied d’égalité avec le code : nous visons à l’améliorer aussi souvent que possible.
\nLes modifications de documentation se présentent généralement sous deux formes :
\nDes améliorations générales : corrections d’orthographe, résolutions d’erreurs et meilleures explications par une écriture plus claire et davantage d’exemples.
Nouvelles fonctionnalités : documentation de fonctionnalités ajoutées au cadre logiciel depuis la version précédente.
Cette section explique comment les rédacteurs peuvent préparer les modifications de documentation de la manière la plus utile possible et qui évite au maximum les erreurs.
\nBien que la documentation de Django soit destinée à être lue au format HTML sur https://docs.djangoproject.com/, nous l’éditons dans un ensemble de fichiers textes écrits dans le langage de balisage reStructuredText pour une souplesse maximale.
\nNous travaillons à partir de la version de développement du dépôt car celle-ci contient la documentation la plus à jour, comme c’est le cas pour le code.
\nLes corrections et améliorations de documentation sont aussi reportées dans la dernière branche publiée, en fonction de leur pertinence jugée par le fusionneur. Nous pensons qu’il est avantageux d’avoir la meilleure documentation possible en tout temps pour la dernière version publiée (voir Différences entre versions).
\nLa documentation de Django utilise le système de documentation Sphinx, qui se base lui-même sur docutils. L’idée de base est de transformer de la documentation en texte brut avec une mise en forme minimale en HTML, PDF ou tout autre format de sortie.
\nSphinx contient une commande sphinx-build pour transformer le texte reStructuredText en d’autres formats, tels que HTML ou PDF. Cette commande est configurable, mais la documentation de Django contient un fichier Makefile qui permet d’utiliser une commande plus courte : make html.
La documentation est scindée en plusieurs catégories :
\nLes tutoriels prennent l’utilisateur par la main à travers une série d’étapes pour créer quelque chose.
\nL’aspect important d’un tutoriel est d’aider le lecteur à accomplir quelque chose d’utile, de préférence aussi vite que possible, dans le but de lui donner confiance.
\nExpliquez la nature du problème à résoudre afin que le lecteur comprenne ce que l’on est en train de faire. Ne pensez pas qu’il faille commencer par des explications sur le fonctionnement des choses ; ce qui compte est ce que le lecteur fait, et non pas ce que vous expliquez. Il peut être utile de faire référence à ce que l’on a fait dans des explications a posteriori.
\nLes guides thématiques visent à expliquer un concept ou un sujet d’un point de vue assez général.
\nFaites des liens vers le matériel de référence plutôt que de le répéter. Utilisez des exemples et n’hésitez pas à expliquer des choses qui vous semblent évidentes, il pourrait s’agir de l’explication dont quelqu’un a vraiment besoin.
\nLa mise à disposition de contexte sous-jacent aide les débutants à faire des liens entre le sujet et des éléments qu’ils connaissent déjà.
\nLes guides de référence contiennent des références techniques pour les API. Ils présentent le fonctionnement de la machinerie interne de Django avec des instructions d’utilisation.
\nRestez bien centré sur le sujet du matériel de référence. Vous pouvez compter sur la connaissance des concepts de base par le lecteur, mais celui-ci cherche à savoir ou à se rappeler comment Django les applique.
\nLes guides de référence ne sont pas l’endroit pour des explications générales. Si vous êtes en train d’expliquer des concepts de base, il pourrait être nécessaire de déplacer ce contenu vers un guide thématique.
\nLes guides pratiques sont des marches à suivre qui accompagnent le lecteur dans une suite d’étapes dans des sujets clés.
\nCe qui compte le plus dans un guide pratique est le résultat attendu par son lecteur. Un guide pratique doit toujours être orienté sur le résultat plutôt que sur des détails internes sur la manière dont Django implémente ce qui est en cours d’étude.
\nCes guides vont plus loin que les tutoriels et comptent sur un certaine connaissance du fonctionnement de Django. On part du principe que le lecteur a suivi les tutoriels. N’hésitez pas à réorienter le lecteur sur un tutoriel adéquat plutôt que de répéter un contenu existant.
\nSi vous souhaitez commencer à contribuer à notre documentation, obtenez la version de développement de Django à partir de son dépôt de code source (voir Installation de la version de développement) :
\nLinux / macOS
$ git clone https://github.com/django/django.git\nWindows
...\\> git clone https://github.com/django/django.git\nSi vous pensez soumettre ces modifications, il est alors utile de créer une fourche du dépôt Django et de plutôt créer une copie locale de cette fourche.
\nCréez et activez un environnement virtuel, puis installez les dépendances :
\n$ python -m venv .venv\n$ source .venv/bin/activate\n$ python -m pip install -r docs/requirements.txt\nIl est possible de construire une version HTML à partir du répertoire docs:
Linux / macOS
$ cd docs\n$ make html\nWindows
...\\> cd docs\n...\\> make.bat html\nLa documentation construite localement sera accessible à partir de _build/html/index.html et visible dans n’importe quel navigateur, même si le thème graphique sera différent de celui de la documentation sur docs.djangoproject.com. Cela ne pose pas de problème. Si vos modifications apparaissent correctement sur votre machine locale, elles seront aussi correctes sur le site web.
Les fichiers sources sont des fichiers .txt situés dans le répertoire docs/.
Ces fichiers sont écrits en langage de balisage reStructuredText. Pour apprendre ce balisage, consultez la ref:référence reStructuredText <sphinx:rst-index>.
\nPour modifier cette page, par exemple, il s’agit d’éditer le fichier docs/internals/contributing/writing-documentation.txt et de reconstruire la sortie HTML avec make html.
Several checks help maintain Django’s documentation quality, including\nspelling,\ncode block formatting, and\ndocumentation style.
\nThese checks are run automatically in CI and must pass before documentation\nchanges can be merged. They can also be run locally with a single command:
\nLinux / macOS
$ make check\nWindows
...\\> make.bat check\nThis command runs all current checks and will include any new checks added in\nthe future.
\nBefore you commit your docs, it’s a good idea to run the spelling checker.\nYou’ll need to install sphinxcontrib-spelling first. Then from the\ndocs directory, run:
Linux / macOS
$ make spelling\nWindows
...\\> make.bat spelling\nWrong words (if any) along with the file and line number where they occur will\nbe saved to _build/spelling/output.txt.
Si vous rencontrez des faux positifs (des erreurs signalées qui n’en sont pas), faites l’une des choses suivantes :
\nSurround inline code or brand/technology names with double grave accents\n(``)
Cherchez des synonymes que le correcteur orthographique connaît.
Si vous êtes certain-e que le mot utilisé est correct, ajoutez-le à la liste docs/spelling_wordlist (en prenant soin de respecter l’ordre alphabétique).
All Python code blocks should be formatted using the blacken-docs\nauto-formatter. This is automatically run by the pre-commit hook if configured.
\nThe check can also be run manually: provided that blacken-docs is\ninstalled, run the following command from the docs directory:
Linux / macOS
$ make black\nWindows
...\\> make.bat black\nThe formatter will report any issues by printing them to the terminal and will\nreformat code blocks where possible.
\nDjango’s documentation is checked for reStructuredText style and formal issues\nusing sphinx-lint. This helps catch problems like stray tabs, trailing\nwhitespace, excessive line length, and similar formatting problems.
\nOnce sphinx-lint is installed, the check can be run with the following\ncommand from the docs directory:
Linux / macOS
$ make lint\nWindows
...\\> make.bat lint\nThe command prints any violations to the terminal in the form\npath:line: message. If problems are encountered:
Read the message and fix the indicated issue (for example, remove trailing\nwhitespace, adjust backticks, or replace tabs with spaces).
For long lines consider wrapping text onto new lines or breaking long inline\nlinks into named references. The custom line length check should already skip\ncommon false positives such as headings, tables and long links.
Links in documentation can become broken or changed such that they are no\nlonger the canonical link. Sphinx provides a builder that can check whether the\nlinks in the documentation are working. From the docs directory, run:
Linux / macOS
$ make linkcheck\nWindows
...\\> make.bat linkcheck\nOutput is printed to the terminal, but can also be found in\n_build/linkcheck/output.txt and _build/linkcheck/output.json.
Les lignes qui ont un statut de « working » sont bonnes, celles qui sont marquées comme « unchecked » ou « ignored » n’ont pas été contrôlées soit car il n’est pas possible de le faire, soit parce qu’elles correspondent à des règles à ignorer dans la configuration.
\nLes lignes qui sont dans l’état « broken » doivent être corrigées. Celles qui sont dans l’état « redirected » ont peut-être besoin d’être mises à jour pour pointer vers leur emplacement canonique, par exemple quand le protocole a passé de http:// → https://. Dans certains cas, un lien redirigé n’a pas besoin d’être mis à jour, par exemple un alias qui pointe toujours vers la dernière version ou la version stable d’une documentation, comme /en/stable/ → /en/3.2/.
Lors d’utilisation de pronoms en référence à une personne hypothétique, comme dans « a user with a session cookie », il est préférable d’utiliser des pronoms neutres. Au lieu de :
\nhe ou she… utilisez they.
him ou her… utilisez them.
his ou her… utilisez their.
his ou hers… utilisez theirs.
himself ou herself… utilisez themselves.
Essayez d’éviter des mots qui minimisent la difficulté impliquée par une tâche ou une opération, tels que « easily », « simply », « just », « merely », « straightforward », etc. L’expérience des gens ne correspond pas forcément à votre attente, et ceux-ci pourraient ressentir de la frustration lorsqu’ils ne trouvent pas qu’une étape est si simple ou évidente que le texte ne le laissait penser.
\nVoici quelques lignes directrices de style pour des termes fréquemment utilisés dans la documentation :
\nDjango – lorsque vous vous référez au cadriciel, toujours avec un D majuscule. Il n’est en minuscules que dans le code Python et dans le logo djangoproject.com.
email – sans trait d’union.
HTTP – la prononciation anglaise habituelle est « Éitch Ti Ti Pi », le terme doit donc être précédé de « an », et pas « a ».
MySQL, PostgreSQL, SQLite
SQL – lorsqu’on se réfère à SQL, la prononciation attendue est « èsquiouèl » et non pas « sicouèl ». Ainsi, dans une phrase comme « Returns an SQL expression », « SQL » doit être précédé d’un « an » et non pas de « a ».
Python – mettre une majuscule quand c’est une référence au langage.
realize, customize, initialize, etc. – utiliser le suffixe américain « ize » et non « ise ».
subclass – en un mot sans trait d’union, que ce soit pour un verbe (« subclass that model ») ou un nom (« create a subclass »).
the web, web framework – sans majuscule.
website – en un seul mot, sans majuscule.
model – sans majuscule.
template – sans majuscule.
URLconf – trois premières lettres en majuscules, sans espace avant « conf ».
view – sans majuscule.
Ces lignes directrices régulent le format de notre documentation reST (reStructuredText) :
\nDans les titres de section, ne mettez en majuscules que les mots initiaux et les noms propres.
Limitez les lignes de la documentation à 80 caractères, sauf si un exemple de code est manifestement moins lisible lorsqu’il est réparti sur deux lignes, ou pour une autre bonne raison.
La chose principale à garder en tête lors de l’écriture et de l’édition de la documentation est que plus il y a de balisage sémantique, mieux c’est. Donc :
\nAdd ``django.contrib.auth`` to your ``INSTALLED_APPS``...\nN’est pas aussi utile que :
\nAdd :mod:`django.contrib.auth` to your :setting:`INSTALLED_APPS`...\nLa raison en est que Sphinx va générer des liens adéquats avec ce deuxième exemple, ce qui aide grandement les lecteurs.
\nIl est possible de préfixer la cible par un ~ (caractère tilde) pour que seul le dernier composant du chemin soit affiché. Par exemple, :mod:`~django.contrib.auth` affichera un lien sur le mot « auth » seul.
Utilisez intersphinx pour ajouter des références aux documentations de Python et de Sphinx.
Ajoutez .. code-block:: <lang> aux blocs littéraux pour que leur syntaxe soit mise en évidence. Mais on préfère en général laisser agir la coloration syntaxique automatique en utilisant :: (deux fois deux-points). L’avantage est que du code contenant de la syntaxe non valable ne sera pas coloré. Si par exemple on ajoute .. code-block:: python, la coloration syntaxique sera forcée même si la syntaxe n’est pas entièrement valable.
Pour améliorer la lisibilité, utilisez .. admonition:: Titre descriptif plutôt que .. note::. Utilisez ces boîtes de manière parcimonieuse.
Utilisez ces styles d’en-têtes :
\n===\nOne\n===\n\nTwo\n===\n\nThree\n-----\n\nFour\n~~~~\n\nFive\n^^^^\nUse :rfc: to reference a Request for Comments (RFC) and\ntry to link to the relevant section if possible. For example, use\n:rfc:`2324#section-2.3.2` or\n:rfc:`Custom link text <2324#section-2.3.2>`.
Utilisez :pep: pour faire référence aux propositions d’amélioration de Python (PEP) et essayez de faire le lien vers la section adéquate si possible. Par exemple, écrivez :pep:`20#easter-egg` ou :pep:`Easter Egg <20#easter-egg>`.
Utilisez :mimetype: pour vous référer à un type MIME sauf si la valeur est entre guillemets pour un exemple de code.
Utilisez :envvar: pour vous référer à une variable d’environnement. Il est parfois aussi nécessaire de définir une référence à la documentation pour cette variable d’environnement en utilisant .. envvar::.
Use :cve: to reference a Common Vulnerabilities and\nExposures (CVE) identifier. For example, use :cve:`2019-14232`.
When documenting Python objects (classes, methods, attributes, etc.) using\nSphinx directives such as .. class::, .. method::, and\n.. attribute::, all content must be properly indented to ensure correct\nrendering and to support features like automatic table of contents\ngeneration.
Follow these rules:
\nThe directive itself remains flush with the left margin (no indentation).
All descriptive text under the directive must be indented by 4 spaces.
Multi-line descriptions must keep the same indentation level.
Nested directives (for example, methods inside a class) require an\nadditional 4 spaces of indentation to maintain hierarchy.
Field lists (such as :param:, :returns:, etc.) must align with the\ndirective’s content level.
Exemple :
\n.. class:: MyClass\n\n A brief description of the class.\n\n .. method:: my_method(arg1, arg2)\n\n Method description.\n\n :param arg1: Description of the first parameter\n :param arg2: Description of the second parameter\n\n .. attribute:: my_attribute\n\n Attribute description.\nEn plus du balisage propre à Sphinx, la documentation de Django définit quelques unités descriptives supplémentaires :
\nRéglages :
\n.. setting:: INSTALLED_APPS\nPour faire un lien vers un réglage, utilisez :setting:`INSTALLED_APPS`.
Balises de gabarit :
\n.. templatetag:: regroup\nPour faire le lien, utilisez :ttag:`regroup`.
Filtres de gabarit :
\n.. templatefilter:: linebreaksbr\nPour faire le lien, utilisez :tfilter:`linebreaksbr`.
Requêtes de champs (par ex. Foo.objects.filter(bar__exact=qqchose)):
.. fieldlookup:: exact\nPour faire le lien, utilisez :lookup:`exact`.
Commandes django-admin:
.. django-admin:: migrate\nPour faire le lien, utilisez :djadmin:`migrate`.
Options de ligne de commande django-admin:
.. django-admin-option:: --traceback\nPour faire le lien, utilisez :option:`nom_commande --traceback` (ou omettez nom_commande pour les options partagées par toutes les commandes comme --verbosity).
Liens vers les tickets Trac (typiquement réservés pour les notes de publication des versions correctives) :
\n:ticket:`12345`\nLa documentation de Django utilise une directive console personnalisée pour la documentation des exemples en ligne de commande impliquant django-admin, manage.py, python, etc.). Dans la production HTML de la documentation, deux onglets apparaîtront dans l’interface, un avec l’invite de commande de type Unix et l’autre avec une invite de commande de style Windows.
Par exemple, vous pouvez remplacer ce fragment :
\nuse this command:\n\n.. code-block:: console\n\n $ python manage.py shell\npar celui-ci :
\nuse this command:\n\n.. console::\n\n $ python manage.py shell\nRemarquez deux choses :
\nVous allez généralement remplacer les occurrences de la directive .. code-block:: console.
Vous n’avez pas besoin de modifier le contenu effectif de l’exemple de code. Vous l’écrivez toujours en imaginant un environnement de type Unix (c’est-à-dire un symbole d’invite '$', '/' comme séparateur de chemins de systèmes de fichiers, etc.)
L’exemple ci-dessus va produire un bloc d’exemple de code avec deux onglets. Le premier contiendra :
\n$ python manage.py shell\n(aucun changement par rapport au rendu .. code-block:: console standard).
Le second contiendra :
\n...\\> py manage.py shell\nNotre politique pour les nouvelles fonctionnalités est la suivante :
\n\n\nToute documentation pour de nouvelles fonctionnalités doit être écrite de manière à ce que les fonctionnalités uniquement disponibles pour la version de développement de Django soient clairement identifiées. Nous partons du principe que les lecteurs de la documentation utilisent la dernière version publiée et non pas la version de développement.
\n
La méthode préférée pour marquer les nouvelles fonctionnalités est de précéder leur documentation par « .. versionadded:: X.Y », suivi d’une ligne vierge obligatoire et d’une description facultative (avec indentation).
Les améliorations générales ou d’autres changements dans l’API qui doivent être mis en évidence utilisent la directive « .. versionchanged:: X.Y » (au même format que la directive versionadded du paragraphe précédent).
Ces blocs versionadded et versionchanged doivent être « autonomes », c’est-à-dire que dans la mesure où ces annotations ne sont conservées que dans deux versions principales, il est utile de pouvoir simplement les enlever sans devoir remettre en forme, changer l’indentation ou modifier le texte avoisinant. Par exemple, au lieu de placer toute la description d’une fonctionnalité nouvelle ou modifiée dans un bloc, faite quelque chose comme ceci :
.. class:: Author(first_name, last_name, middle_name=None)\n\n A person who writes books.\n\n ``first_name`` is ...\n\n ...\n\n ``middle_name`` is ...\n\n .. versionchanged:: A.B\n\n The ``middle_name`` argument was added.\nPlacez les annotations pour les modifications au bas de la section, et non pas au-dessus.
\nDe même, évitez de faire référence à une version spécifique de Django en dehors des blocs versionadded et versionchanged. Même dans un bloc, il est souvent redondant de mentionner des versions puisque le rendu automatique de ces annotations produit respectivement « New in Django A.B » et « Changed in Django A.B ».
Si une fonction, un attribut, etc. a été ajouté, il est aussi admis d’utiliser une annotation versionadded comme ceci :
.. attribute:: Author.middle_name\n\n .. versionadded:: A.B\n\n An author's middle name.\nNous pouvons enlever l’annotation .. versionadded:: A.B sans aucun changement d’indentation lorsque ce sera le bon moment.
Optimisez la taille de compression des images quand c’est possible, pour les fichiers PBG, utilisez OptiPNG et advpng de AdvanceCOMP :
Linux / macOS
$ cd docs\n$ optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path "./_build/*" -name "*.png"`\n$ advpng -z4 `find . -type f -not -path "./_build/*" -name "*.png"`\nWindows
...\\> cd docs\n...\\> optipng -o7 -zm1-9 -i0 -strip all `find . -type f -not -path ".\\_build\\*" -name "*.png"`\n...\\> advpng -z4 `find . -type f -not -path ".\\_build\\*" -name "*.png"`\nCet exemple est basé sur la version 0.7.5 de OptiPNG. Les versions plus anciennes peuvent se plaindre que l’option -strip all perd des données.
Pour un exemple rapide sur la manière dont tout s’enchaîne, considérez l’exemple hypothétique suivant :
\nTout d’abord, la disposition générale du document ref/settings.txt pourrait ressembler à ceci :
========\nSettings\n========\n\n...\n\n.. _available-settings:\n\nAvailable settings\n==================\n\n...\n\n.. _deprecated-settings:\n\nDeprecated settings\n===================\n\n...\nEnsuite, le document topics/settings.txt pourrait contenir quelque chose comme :
You can access a :ref:`listing of all available settings\n<available-settings>`. For a list of deprecated settings see\n:ref:`deprecated-settings`.\n\nYou can find both in the :doc:`settings reference document\n</ref/settings>`.\nNous utilisons l’élément de référence croisée de Sphinx doc lorsque nous ajoutons un lien vers un autre document dans son entier et l’élément ref lorsque nous ajoutons un lien vers un emplacement spécifique dans un document.
Puis, voyez comment les réglages sont annotés :
\n.. setting:: ADMINS\n\nADMINS\n======\n\nDefault: ``[]`` (Empty list)\n\nA list of all the people who get code error notifications...\nCeci balise l’en-tête suivante comme la cible « canonique » du réglage ADMINS. Cela signifie que lors de chaque mention de ADMINS, on peut y faire référence avec :setting:`ADMINS`.
C’est grosso modo ainsi que le tout fonctionne.
\nConsultez Traduction de la documentation de Django si vous souhaitez aider à traduire la documentation dans une autre langue.
\ndjango-adminLien vers cette rubrique#Sphinx peut générer une page de manuel pour la commande django-admin. Ceci est configuré dans docs/conf.py. Au contraire d’autres productions de documentation, cette page de manuel devrait être contenue dans le dépôt de Django et dans ses publications comme docs/man/django-admin.1. Il n’est pas nécessaire de mettre à jour ce fichier lors de la mise à jour de la documentation, car sa mise est jour fait partie du processus de publication.
To generate an updated version of the man page, in the docs directory, run:
Linux / macOS
$ make man\nWindows
...\\> make.bat man\nThe new man page will be written in docs/_build/man/django-admin.1.