diff options
| author | David Smith <smithdc@gmail.com> | 2025-06-02 08:22:08 +0100 |
|---|---|---|
| committer | nessita <124304+nessita@users.noreply.github.com> | 2025-08-25 10:51:10 -0300 |
| commit | 43e4d0a1422d87cc804097f7eb127b6ffa07e840 (patch) | |
| tree | 7a559d75c990963a272c8546022ee4d84924f968 /docs/internals/contributing/writing-code/unit-tests.txt | |
| parent | f81e6e3a53ee36e3f730a71aa55a5744982dd016 (diff) | |
Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.
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.
Diffstat (limited to 'docs/internals/contributing/writing-code/unit-tests.txt')
| -rw-r--r-- | docs/internals/contributing/writing-code/unit-tests.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 05b2bf09c6..b4bc429af5 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
