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

Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.

Browse Source 
The `check` docs target now runs spelling, black, and lint, so all
current documentation quality checks can be run with a single command.

Also documented the lint-docs check's availability and usage.
This commit is contained in:
David Smith
2025-06-02 08:22:08 +01:00
committed by nessita
parent f81e6e3a53
commit 43e4d0a142
7 changed files with 64 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/internals/contributing/writing-code/unit-tests.txt
View File

@@ -69,11 +69,11 @@ command from any place in the Django source tree:
$ tox
By default, ``tox`` runs the test suite with the bundled test settings file for
SQLite, ``black``, ``blacken-docs``, ``flake8``, ``isort``, and the
documentation spelling checker. In addition to the system dependencies noted
elsewhere in this documentation, the command ``python3`` must be on your path
and linked to the appropriate version of Python. A list of default environments
can be seen as follows:
SQLite, ``black``, ``blacken-docs``, ``flake8``, ``isort``, ``lint-docs`` and
the documentation spelling checker. In addition to the system dependencies
noted elsewhere in this documentation, the command ``python3`` must be on your
path and linked to the appropriate version of Python. A list of default
environments can be seen as follows:
.. console::
@@ -84,6 +84,7 @@ can be seen as follows:
flake8>=3.7.0
docs
isort>=5.1.0
lint-docs
Testing other Python versions and database backends
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~