diff options
Diffstat (limited to 'docs/internals/contributing')
3 files changed, 11 insertions, 7 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt index 43db31501e..6793dde79e 100644 --- a/docs/internals/contributing/writing-code/coding-style.txt +++ b/docs/internals/contributing/writing-code/coding-style.txt @@ -283,8 +283,8 @@ at the top level (i.e. evaluated when the module is imported). The explanation for this is as follows: Manual configuration of settings (i.e. not relying on the -``DJANGO_SETTINGS_MODULE`` environment variable) is allowed and possible as -follows:: +:envvar:`DJANGO_SETTINGS_MODULE` environment variable) is allowed and possible +as follows:: from django.conf import settings diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 21bdf00664..deaa5a0b19 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -105,8 +105,8 @@ The remainder of this documentation shows commands for running tests without ``tox``, however, any option passed to ``runtests.py`` can also be passed to ``tox`` by prefixing the argument list with ``--``, as above. -Tox also respects the ``DJANGO_SETTINGS_MODULE`` environment variable, if set. -For example, the following is equivalent to the command above: +Tox also respects the :envvar:`DJANGO_SETTINGS_MODULE` environment variable, if +set. For example, the following is equivalent to the command above: .. code-block:: console @@ -156,7 +156,7 @@ those for ``contrib.postgres``, are specific to a particular database backend and will be skipped if run with a different backend. To run the tests with different settings, ensure that the module is on your -``PYTHONPATH`` and pass the module with ``--settings``. +:envvar:`PYTHONPATH` and pass the module with ``--settings``. The :setting:`DATABASES` setting in any test settings module needs to define two databases: @@ -495,8 +495,8 @@ test failures. You can adjust this behavior with the ``--parallel`` option: $ ./runtests.py basic --parallel=1 -You can also use the ``DJANGO_TEST_PROCESSES`` environment variable for this -purpose. +You can also use the :envvar:`DJANGO_TEST_PROCESSES` environment variable for +this purpose. Tips for writing tests ====================== diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index bd9d0e9495..82f918f921 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -246,6 +246,10 @@ documentation: * Use :rst:role:`:mimetype:<mimetype>` to refer to a MIME Type unless the value is quoted for a code example. +* Use :rst:role:`:envvar:<envvar>` to refer to an environment variable. You may + also need to define a reference to the documentation for that environment + variable using :rst:dir:`.. envvar:: <envvar>`. + Django-specific markup ====================== |