mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-24 14:16:09 +00:00
Code Issues 32 Releases Wiki Activity

Refs #36485 -- Grouped docs checks under a unified make check target.

Browse Source 
Added a new 'check' rule to the docs Makefile which runs both the black
and spelling checks.
This commit is contained in:
David Smith
2025-06-25 21:40:07 +01:00
committed by nessita
parent cba7328196
commit 7f9bf357fe
3 changed files with 47 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/internals/contributing/writing-documentation.txt
View File

@@ -152,10 +152,29 @@ To edit this page, for example, we would edit the file
:source:`docs/internals/contributing/writing-documentation.txt` and rebuild the
HTML with ``make html``.
.. _documentation-checks:
Documentation quality checks
----------------------------
Several checks help maintain Django's documentation quality, including
:ref:`spelling <documentation-spelling-check>` and
:ref:`code block formatting <documentation-code-block-format-check>`.
These checks are run automatically in CI and must pass before documentation
changes can be merged. They can also be run locally with a single command:
.. console::
$ make check
This command runs all current checks and will include any new checks added in
the future.
.. _documentation-spelling-check:
Spelling check
--------------
~~~~~~~~~~~~~~
Before you commit your docs, it's a good idea to run the spelling checker.
You'll need to install :pypi:`sphinxcontrib-spelling` first. Then from the
@@ -180,7 +199,7 @@ one of the following:
.. _documentation-code-block-format-check:
Code block format check
-----------------------
~~~~~~~~~~~~~~~~~~~~~~~
All Python code blocks should be formatted using the :pypi:`blacken-docs`
auto-formatter. This is automatically run by the :ref:`pre-commit hook