diff options
| author | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2023-02-28 13:14:51 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2023-03-01 13:02:57 +0100 |
| commit | 6015bab80e28aef2669f6fac53423aa65f70cb08 (patch) | |
| tree | b0a8eabf00294f3b85868fd79931de2f02d5b4b9 /docs/internals/contributing/writing-code | |
| parent | 9cf2a5df70051dffcefe21c6b27203e2d5804922 (diff) | |
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
This adds:
- GitHub actions,
- tox configuration,
- pre-commit hook, and
- makefile rules
to run blacken-docs linter.
Co-authored-by: David Smith <smithdc@gmail.com>
Diffstat (limited to 'docs/internals/contributing/writing-code')
| -rw-r--r-- | docs/internals/contributing/writing-code/submitting-patches.txt | 6 | ||||
| -rw-r--r-- | docs/internals/contributing/writing-code/unit-tests.txt | 11 |
2 files changed, 9 insertions, 8 deletions
diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt index 0ab3e27def..14cb2ef2fa 100644 --- a/docs/internals/contributing/writing-code/submitting-patches.txt +++ b/docs/internals/contributing/writing-code/submitting-patches.txt @@ -291,9 +291,9 @@ All code changes * Does the :doc:`coding style </internals/contributing/writing-code/coding-style>` conform to our - guidelines? Are there any ``black``, ``flake8``, or ``isort`` errors? You - can install the :ref:`pre-commit <coding-style-pre-commit>` hooks to - automatically catch these errors. + guidelines? Are there any ``black``, ``blacken-docs``, ``flake8``, or + ``isort`` errors? You can install the :ref:`pre-commit + <coding-style-pre-commit>` hooks to automatically catch these errors. * If the change is backwards incompatible in any way, is there a note in the release notes (``docs/releases/A.B.txt``)? * Is Django's test suite passing? diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index b547a28049..8789e0ef7b 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -69,17 +69,18 @@ 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``, ``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``, 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:: $ tox -l py3 black + blacken-docs flake8>=3.7.0 docs isort>=5.1.0 |