Skip to content

Commit 3740cb9

Browse files
authored
doc: indent envvar directive bodies in reference.rst (#14183)
Indent the body text of all 14 ``.. envvar::`` entries with 3 spaces, matching the ``.. confval::`` convention used in the same file. This was the only section with unindented directive bodies.
1 parent b2310f2 commit 3740cb9

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

doc/en/reference/reference.rst

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1179,77 +1179,77 @@ Environment variables that can be used to change pytest's behavior.
11791179

11801180
.. envvar:: CI
11811181

1182-
When set to a non-empty value, pytest acknowledges that it is running in a CI process. See also :ref:`ci-pipelines`.
1182+
When set to a non-empty value, pytest acknowledges that it is running in a CI process. See also :ref:`ci-pipelines`.
11831183

11841184
.. envvar:: BUILD_NUMBER
11851185

1186-
When set to a non-empty value, pytest acknowledges that it is running in a CI process. Alternative to :envvar:`CI`. See also :ref:`ci-pipelines`.
1186+
When set to a non-empty value, pytest acknowledges that it is running in a CI process. Alternative to :envvar:`CI`. See also :ref:`ci-pipelines`.
11871187

11881188
.. envvar:: PYTEST_ADDOPTS
11891189

1190-
This contains a command-line (parsed by the py:mod:`shlex` module) that will be **prepended** to the command line given
1191-
by the user, see :ref:`adding default options` for more information.
1190+
This contains a command-line (parsed by the py:mod:`shlex` module) that will be **prepended** to the command line given
1191+
by the user, see :ref:`adding default options` for more information.
11921192

11931193
.. envvar:: PYTEST_VERSION
11941194

1195-
This environment variable is defined at the start of the pytest session and is undefined afterwards.
1196-
It contains the value of ``pytest.__version__``, and among other things can be used to easily check if a code is running from within a pytest run.
1195+
This environment variable is defined at the start of the pytest session and is undefined afterwards.
1196+
It contains the value of ``pytest.__version__``, and among other things can be used to easily check if a code is running from within a pytest run.
11971197

11981198
.. envvar:: PYTEST_CURRENT_TEST
11991199

1200-
This is not meant to be set by users, but is set by pytest internally with the name of the current test so other
1201-
processes can inspect it, see :ref:`pytest current test env` for more information.
1200+
This is not meant to be set by users, but is set by pytest internally with the name of the current test so other
1201+
processes can inspect it, see :ref:`pytest current test env` for more information.
12021202

12031203
.. envvar:: PYTEST_DEBUG
12041204

1205-
When set, pytest will print tracing and debug information.
1205+
When set, pytest will print tracing and debug information.
12061206

12071207
.. envvar:: PYTEST_DEBUG_TEMPROOT
12081208

1209-
Root for temporary directories produced by fixtures like :fixture:`tmp_path`
1210-
as discussed in :ref:`temporary directory location and retention`.
1209+
Root for temporary directories produced by fixtures like :fixture:`tmp_path`
1210+
as discussed in :ref:`temporary directory location and retention`.
12111211

12121212
.. envvar:: PYTEST_DISABLE_PLUGIN_AUTOLOAD
12131213

1214-
When set, disables plugin auto-loading through :std:doc:`entry point packaging
1215-
metadata <packaging:guides/creating-and-discovering-plugins>`. Only plugins
1216-
explicitly specified in :envvar:`PYTEST_PLUGINS` or with :option:`-p` will be loaded.
1217-
See also :ref:`--disable-plugin-autoload <disable_plugin_autoload>`.
1214+
When set, disables plugin auto-loading through :std:doc:`entry point packaging
1215+
metadata <packaging:guides/creating-and-discovering-plugins>`. Only plugins
1216+
explicitly specified in :envvar:`PYTEST_PLUGINS` or with :option:`-p` will be loaded.
1217+
See also :ref:`--disable-plugin-autoload <disable_plugin_autoload>`.
12181218

12191219
.. envvar:: PYTEST_PLUGINS
12201220

1221-
Contains comma-separated list of modules that should be loaded as plugins:
1221+
Contains comma-separated list of modules that should be loaded as plugins:
12221222

1223-
.. code-block:: bash
1223+
.. code-block:: bash
12241224
1225-
export PYTEST_PLUGINS=mymodule.plugin,xdist
1225+
export PYTEST_PLUGINS=mymodule.plugin,xdist
12261226
1227-
See also :option:`-p`.
1227+
See also :option:`-p`.
12281228

12291229
.. envvar:: PYTEST_THEME
12301230

1231-
Sets a `pygment style <https://pygments.org/docs/styles/>`_ to use for the code output.
1231+
Sets a `pygment style <https://pygments.org/docs/styles/>`_ to use for the code output.
12321232

12331233
.. envvar:: PYTEST_THEME_MODE
12341234

1235-
Sets the :envvar:`PYTEST_THEME` to be either *dark* or *light*.
1235+
Sets the :envvar:`PYTEST_THEME` to be either *dark* or *light*.
12361236

12371237
.. envvar:: PY_COLORS
12381238

1239-
When set to ``1``, pytest will use color in terminal output.
1240-
When set to ``0``, pytest will not use color.
1241-
``PY_COLORS`` takes precedence over ``NO_COLOR`` and ``FORCE_COLOR``.
1239+
When set to ``1``, pytest will use color in terminal output.
1240+
When set to ``0``, pytest will not use color.
1241+
``PY_COLORS`` takes precedence over ``NO_COLOR`` and ``FORCE_COLOR``.
12421242

12431243
.. envvar:: NO_COLOR
12441244

1245-
When set to a non-empty string (regardless of value), pytest will not use color in terminal output.
1246-
``PY_COLORS`` takes precedence over ``NO_COLOR``, which takes precedence over ``FORCE_COLOR``.
1247-
See `no-color.org <https://no-color.org/>`__ for other libraries supporting this community standard.
1245+
When set to a non-empty string (regardless of value), pytest will not use color in terminal output.
1246+
``PY_COLORS`` takes precedence over ``NO_COLOR``, which takes precedence over ``FORCE_COLOR``.
1247+
See `no-color.org <https://no-color.org/>`__ for other libraries supporting this community standard.
12481248

12491249
.. envvar:: FORCE_COLOR
12501250

1251-
When set to a non-empty string (regardless of value), pytest will use color in terminal output.
1252-
``PY_COLORS`` and ``NO_COLOR`` take precedence over ``FORCE_COLOR``.
1251+
When set to a non-empty string (regardless of value), pytest will use color in terminal output.
1252+
``PY_COLORS`` and ``NO_COLOR`` take precedence over ``FORCE_COLOR``.
12531253

12541254
Exceptions
12551255
----------

0 commit comments

Comments
 (0)