Skip to content

Commit 60c9dc2

Browse files
authored
Update tox.rst
1 parent f8c385a commit 60c9dc2

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

Users/tox.rst

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,25 @@ right next to your setup.py file:
3333
# whatever extra steps before testing might be necessary
3434
pytest # or any other test runner that you might use
3535
36-
.. Note ::
36+
.. note::
3737

38-
Note
39-
40-
You can also try generating a tox.ini file automatically, by running
41-
tox-quickstart and then answering a few simple questions.
42-
To sdist-package, install and test your project against Python2.7 and
43-
Python3.6, just type:
38+
You can also try generating a tox.ini file automatically, by running
39+
tox-quickstart and then answering a few simple questions.
40+
To sdist-package, install and test your project against Python2.7 and
41+
Python3.6, just type:
4442

4543
::
4644

47-
tox
45+
tox
46+
47+
.. note::
4848

49-
and watch things happening (you must have python2.7 and python3.6 installed
50-
in your environment
51-
otherwise you will see errors). When you run tox a second time you’ll note
52-
that it runs much faster
53-
because it keeps track of virtualenv details and will not recreate or
54-
re-install dependencies.
55-
You also might want to checkout tox configuration and usage examples to get
56-
some more ideas.
49+
and watch things happening (you must have python2.7 and python3.6
50+
installed in your environment otherwise you will see errors). When
51+
you run tox a second time you’ll note that it runs much faster
52+
because it keeps track of virtualenv details and will not recreate or
53+
re-install dependencies.You also might want to checkout tox configuration
54+
and usage examples to get some more ideas.
5755

5856
Sections
5957
--------
@@ -63,26 +61,27 @@ on all subsections inside of a tox section please refer to the tox
6361
documentation.
6462

6563
- ``tox`` : This section contains the ``envlist`` which is used to create
66-
our dynamic matrix. Refer to the `section here <http://tox.readthedocs.io/
67-
en/latest/config.html#generating-environments-conditional-settings>`_ for
68-
more information on how the ``envlist`` works.
64+
our dynamic matrix. Refer to the `section here <http://tox.readthedocs.io/
65+
en/latest/config.html#generating-environments-conditional-settings>`_ for
66+
more information on how the ``envlist`` works.
6967

7068
- ``purge`` : This section contains commands that only run for scenarios
71-
that purge the cluster and redeploy. You'll see this section being reused in
69+
that purge the cluster and redeploy. You'll see this section being reused in
7270
``testenv``with the following syntax: ``{[purge]commands}``
7371

7472
- ``update`` : This section contains commands taht only run for scenarios
75-
that
76-
deploy a cluster and then upgrade it to another Ceph version.
73+
that
74+
deploy a cluster and then upgrade it to another Ceph version.
7775

7876
- ``testenv`` : This is the main section of the ``tox.ini`` file and is run
79-
on every scenario. This section contains many *factors* that define
80-
conditional settings depending on the scenarios defined in the ``envlist``.
81-
For example, the factor``centos7_cluster`` in the ``changedir`` subsection
82-
of ``testenv`` sets the directory that tox will change do when that factor
83-
is selected. This is an important behavior that allows us to use the same
77+
on every scenario. This section contains many *factors* that define
78+
conditional settings depending on the scenarios defined in the
79+
``envlist``.
80+
For example, the factor``centos7_cluster`` in the ``changedir`` subsection
81+
of ``testenv`` sets the directory that tox will change do when that factor
82+
is selected. This is an important behavior that allows us to use the same
8483
``tox.ini`` and reuse commands while tweaking certain sections per testing
85-
scenario.
84+
scenario.
8685

8786
Modifying or Adding environments
8887
--------------------------------

0 commit comments

Comments
 (0)