summaryrefslogtreecommitdiff
path: root/docs/internals
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2023-02-28 13:14:51 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2023-03-01 13:34:28 +0100
commit32f224e359c68e70e3f9a230be0265dcd6677079 (patch)
treef1f83e61d5f4888e3728c217b4c6c20441952914 /docs/internals
parent8d2ac000e43c1cfa3d331a1580525ead3d5f32d7 (diff)
[4.2.x] 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> Backport of 6015bab80e28aef2669f6fac53423aa65f70cb08 from main
Diffstat (limited to 'docs/internals')
-rw-r--r--docs/internals/contributing/writing-code/submitting-patches.txt6
-rw-r--r--docs/internals/contributing/writing-code/unit-tests.txt11
-rw-r--r--docs/internals/contributing/writing-documentation.txt10
3 files changed, 19 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 0d711a8af1..12c9dae8c7 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
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index a89ea050d5..3e6b846a7a 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -211,6 +211,9 @@ documentation:
"last bit" of that path. So ``:mod:`~django.contrib.auth``` will
display a link with the title "auth".
+* All Python code blocks should be formatted using the `blacken-docs`_
+ auto-formatter. This will be run by ``pre-commit`` if that is configured.
+
* Use :mod:`~sphinx.ext.intersphinx` to reference Python's and Sphinx'
documentation.
@@ -258,6 +261,13 @@ documentation:
also need to define a reference to the documentation for that environment
variable using :rst:dir:`.. envvar:: <envvar>`.
+.. versionchanged:: 4.2
+
+ All Python code blocks in the Django documentation were reformatted with
+ `blacken-docs`_.
+
+.. _blacken-docs: https://pypi.org/project/blacken-docs/
+
Django-specific markup
======================