Skip to content

Commit 214d0d9

Browse files
committed
trivial: Fix indentation/alignment in doc/config.rst
Signed-off-by: Stephen Finucane <[email protected]>
1 parent 37f59d5 commit 214d0d9

File tree

1 file changed

+73
-67
lines changed

1 file changed

+73
-67
lines changed

doc/config.rst

Lines changed: 73 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Complete list of settings that you can put into ``testenv*`` sections:
9393

9494
.. confval:: commands=ARGVLIST
9595

96-
the commands to be called for testing. Each command is defined
96+
The commands to be called for testing. Each command is defined
9797
by one or more lines; a command can have multiple lines if a line
9898
ends with the ``\`` character in which case the subsequent line
9999
will be appended (and may contain another ``\`` character ...).
@@ -106,7 +106,7 @@ Complete list of settings that you can put into ``testenv*`` sections:
106106

107107
.. versionadded:: 1.6
108108

109-
the ``install_command`` setting is used for installing packages into
109+
The ``install_command`` setting is used for installing packages into
110110
the virtual environment; both the package under test
111111
and its dependencies (defined with :confval:`deps`).
112112
Must contain the substitution key
@@ -121,38 +121,36 @@ Complete list of settings that you can put into ``testenv*`` sections:
121121

122122
pip install {opts} {packages}
123123

124-
125124
.. confval:: list_dependencies_command
126125

127126
.. versionadded:: 2.4
128127

129-
the ``list_dependencies_command`` setting is used for listing
128+
The ``list_dependencies_command`` setting is used for listing
130129
the packages installed into the virtual environment.
131130

132131
**default**::
133132

134133
pip freeze
135134

136-
137135
.. confval:: ignore_errors=True|False(default)
138136

139137
.. versionadded:: 2.0
140138

141-
If ``True``, a non-zero exit code from one command will be ignored and
142-
further commands will be executed (which was the default behavior in tox <
143-
2.0). If ``False`` (the default), then a non-zero exit code from one command
144-
will abort execution of commands for that environment.
139+
If ``True``, a non-zero exit code from one command will be ignored and
140+
further commands will be executed (which was the default behavior in tox <
141+
2.0). If ``False`` (the default), then a non-zero exit code from one
142+
command will abort execution of commands for that environment.
145143

146-
It may be helpful to note that this setting is analogous to the ``-i`` or
147-
``ignore-errors`` option of GNU Make. A similar name was chosen to reflect the
148-
similarity in function.
144+
It may be helpful to note that this setting is analogous to the ``-i`` or
145+
``ignore-errors`` option of GNU Make. A similar name was chosen to reflect
146+
the similarity in function.
149147

150-
Note that in tox 2.0, the default behavior of tox with respect to
151-
treating errors from commands changed. tox < 2.0 would ignore errors by
152-
default. tox >= 2.0 will abort on an error by default, which is safer and more
153-
typical of CI and command execution tools, as it doesn't make sense to
154-
run tests if installing some prerequisite failed and it doesn't make sense to
155-
try to deploy if tests failed.
148+
Note that in tox 2.0, the default behavior of tox with respect to treating
149+
errors from commands changed. tox < 2.0 would ignore errors by default. tox
150+
>= 2.0 will abort on an error by default, which is safer and more typical
151+
of CI and command execution tools, as it doesn't make sense to run tests if
152+
installing some prerequisite failed and it doesn't make sense to try to
153+
deploy if tests failed.
156154

157155
.. confval:: pip_pre=True|False(default)
158156

@@ -182,11 +180,12 @@ Complete list of settings that you can put into ``testenv*`` sections:
182180
.. confval:: changedir=path
183181

184182
change to this working directory when executing the test command.
183+
185184
**default**: ``{toxinidir}``
186185

187186
.. confval:: deps=MULTI-LINE-LIST
188187

189-
test-specific dependencies - to be installed into the environment prior to project
188+
Test-specific dependencies - to be installed into the environment prior to project
190189
package installation. Each line defines a dependency, which will be
191190
passed to the installer command for processing (see :confval:`indexserver`).
192191
Each line specifies a file, a URL or a package name. You can additionally specify
@@ -212,51 +211,53 @@ Complete list of settings that you can put into ``testenv*`` sections:
212211

213212
.. confval:: setenv=MULTI-LINE-LIST
214213

215-
.. versionadded:: 0.9
214+
.. versionadded:: 0.9
216215

217-
each line contains a NAME=VALUE environment variable setting which
218-
will be used for all test command invocations as well as for installing
219-
the sdist package into a virtual environment.
216+
Each line contains a NAME=VALUE environment variable setting which
217+
will be used for all test command invocations as well as for installing
218+
the sdist package into a virtual environment.
220219

221220
.. confval:: passenv=SPACE-SEPARATED-GLOBNAMES
222221

223-
.. versionadded:: 2.0
222+
.. versionadded:: 2.0
224223

225-
A list of wildcard environment variable names which
226-
shall be copied from the tox invocation environment to the test
227-
environment when executing test commands. If a specified environment
228-
variable doesn't exist in the tox invocation environment it is ignored.
229-
You can use ``*`` and ``?`` to match multiple environment variables with
230-
one name.
224+
A list of wildcard environment variable names which
225+
shall be copied from the tox invocation environment to the test
226+
environment when executing test commands. If a specified environment
227+
variable doesn't exist in the tox invocation environment it is ignored.
228+
You can use ``*`` and ``?`` to match multiple environment variables with
229+
one name.
231230

232-
Some variables are always passed through to ensure the basic functionality
233-
of standard library functions or tooling like pip:
231+
Some variables are always passed through to ensure the basic functionality
232+
of standard library functions or tooling like pip:
234233

235-
* passed through on all platforms: ``PATH``, ``LANG``, ``LANGUAGE``,
236-
``LD_LIBRARY_PATH``, ``PIP_INDEX_URL``
237-
* Windows: ``SYSTEMDRIVE``, ``SYSTEMROOT``, ``PATHEXT``, ``TEMP``, ``TMP``
238-
``NUMBER_OF_PROCESSORS``, ``USERPROFILE``, ``MSYSTEM``
239-
* Others (e.g. UNIX, macOS): ``TMPDIR``
234+
* passed through on all platforms: ``PATH``, ``LANG``, ``LANGUAGE``,
235+
``LD_LIBRARY_PATH``, ``PIP_INDEX_URL``
236+
* Windows: ``SYSTEMDRIVE``, ``SYSTEMROOT``, ``PATHEXT``, ``TEMP``, ``TMP``
237+
``NUMBER_OF_PROCESSORS``, ``USERPROFILE``, ``MSYSTEM``
238+
* Others (e.g. UNIX, macOS): ``TMPDIR``
240239

241-
You can override these variables with the ``setenv`` option.
240+
You can override these variables with the ``setenv`` option.
242241

243-
If defined the ``TOX_TESTENV_PASSENV`` environment variable (in the tox
244-
invocation environment) can define additional space-separated variable
245-
names that are to be passed down to the test command environment.
242+
If defined the ``TOX_TESTENV_PASSENV`` environment variable (in the tox
243+
invocation environment) can define additional space-separated variable
244+
names that are to be passed down to the test command environment.
246245

247-
.. versionchanged:: 2.7
246+
.. versionchanged:: 2.7
248247

249-
``PYTHONPATH`` will be passed down if explicitly defined. If ``PYTHONPATH``
250-
exists in the host environment but is **not** declared in ``passenv`` a
251-
warning will be emitted.
248+
``PYTHONPATH`` will be passed down if explicitly defined. If
249+
``PYTHONPATH`` exists in the host environment but is **not** declared
250+
in ``passenv`` a warning will be emitted.
252251

253252
.. confval:: recreate=True|False(default)
254253

255254
Always recreate virtual environment if this option is True.
256255

257256
.. confval:: downloadcache=path
258257

259-
**IGNORED** -- Since pip-8 has caching by default this option is now ignored. Please remove it from your configs as a future tox version might bark on it.
258+
**IGNORED** -- Since pip-8 has caching by default this option is now
259+
ignored. Please remove it from your configs as a future tox version might
260+
bark on it.
260261

261262
.. confval:: sitepackages=True|False
262263

@@ -268,60 +269,65 @@ Complete list of settings that you can put into ``testenv*`` sections:
268269

269270
.. confval:: alwayscopy=True|False
270271

271-
Set to ``True`` if you want virtualenv to always copy files rather than symlinking.
272+
Set to ``True`` if you want virtualenv to always copy files rather than
273+
symlinking.
272274

273-
This is useful for situations where hardlinks don't work (e.g. running in VMS with Windows guests).
275+
This is useful for situations where hardlinks don't work (e.g. running in
276+
VMS with Windows guests).
274277

275278
**default:** False, meaning that virtualenvs will make use of symbolic links.
276279

277280
.. confval:: args_are_paths=BOOL
278281

279-
treat positional arguments passed to ``tox`` as file system paths
282+
Treat positional arguments passed to ``tox`` as file system paths
280283
and - if they exist on the filesystem - rewrite them according
281284
to the ``changedir``.
285+
282286
**default**: True (due to the exists-on-filesystem check it's
283287
usually safe to try rewriting).
284288

285289
.. confval:: envtmpdir=path
286290

287-
defines a temporary directory for the virtualenv which will be cleared
291+
Defines a temporary directory for the virtualenv which will be cleared
288292
each time before the group of test commands is invoked.
293+
289294
**default**: ``{envdir}/tmp``
290295

291296
.. confval:: envlogdir=path
292297

293-
defines a directory for logging where tox will put logs of tool
298+
Defines a directory for logging where tox will put logs of tool
294299
invocation.
300+
295301
**default**: ``{envdir}/log``
296302

297303
.. confval:: indexserver
298304

299-
.. versionadded:: 0.9
305+
.. versionadded:: 0.9
300306

301-
(DEPRECATED, will be removed in a future version) Multi-line ``name =
302-
URL`` definitions of python package servers. Dependencies can
303-
specify using a specified index server through the
304-
``:indexservername:depname`` pattern. The ``default`` indexserver
305-
definition determines where unscoped dependencies and the sdist install
306-
installs from. Example:
307+
(DEPRECATED, will be removed in a future version) Multi-line ``name =
308+
URL`` definitions of python package servers. Dependencies can
309+
specify using a specified index server through the
310+
``:indexservername:depname`` pattern. The ``default`` indexserver
311+
definition determines where unscoped dependencies and the sdist install
312+
installs from. Example:
307313

308-
.. code-block:: ini
314+
.. code-block:: ini
309315
310316
[tox]
311317
indexserver =
312318
default = http://mypypi.org
313319
314-
will make tox install all dependencies from this PYPI index server
315-
(including when installing the project sdist package).
316-
320+
will make tox install all dependencies from this PYPI index server
321+
(including when installing the project sdist package).
317322

318323
.. confval:: envdir
319324

320-
.. versionadded:: 1.5
325+
.. versionadded:: 1.5
326+
327+
User can set specific path for environment. If path would not be absolute
328+
it would be treated as relative to ``{toxinidir}``.
321329

322-
User can set specific path for environment. If path would not be absolute it
323-
would be treated as relative to ``{toxinidir}``. **default**:
324-
``{toxworkdir}/{envname}``
330+
**default**: ``{toxworkdir}/{envname}``
325331

326332
.. confval:: usedevelop=BOOL
327333

@@ -363,7 +369,7 @@ Complete list of settings that you can put into ``testenv*`` sections:
363369

364370
.. confval:: description=SINGLE-LINE-TEXT
365371

366-
a short description of the environment, this will be used to explain
372+
A short description of the environment, this will be used to explain
367373
the environment to the user upon listing environments for the command
368374
line with any level of verbosity higher than zero. **default**: empty string
369375

0 commit comments

Comments
 (0)