Create tox.rst #578
Create tox.rst #578
Conversation
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: 0e81ece0-f0db-11e8-a427-d38b467abfda |
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: c4c81d70-f0eb-11e8-a427-d38b467abfda |
| # whatever extra steps before testing might be necessary | ||
| pytest # or any other test runner that you might use | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
(ERROR/3) Content block expected for the "note" directive; none found.
Origin: RSTcheckBear, Section: rstcheck.
Users/tox.rst
Outdated
|
|
||
| - checking your package installs correctly with different Python versions and interpreters | ||
| - running your tests in each of the environments, configuring your test tool of choice | ||
| - acting as a frontend to Continuous Integration servers, greatly reducing boilerplate and merging CI and shell-based testing. |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpcjm1qi87/Users/tox.rst
+++ b/tmp/tmpcjm1qi87/Users/tox.rst
@@ -25,7 +25,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
Note:
You can also try generating a tox.ini file automatically, by running tox-quickstart 
|
Comment on 6fae468, file Users/tox.rst, line 82. (INFO/1) Hyperlink target "tox-sections" is not referenced. Origin: RSTcheckBear, Section: |
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: 6c7a7440-f0ed-11e8-a427-d38b467abfda |
| # whatever extra steps before testing might be necessary | ||
| pytest # or any other test runner that you might use | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
(ERROR/3) Content block expected for the "note" directive; none found.
Origin: RSTcheckBear, Section: rstcheck.
|
Comment on 9832fdf, file Users/tox.rst, line 28. Line contains following spacing inconsistencies:
Origin: SpaceConsistencyBear, Section: The issue can be fixed by applying the following patch: --- a/tmp/tmpiwjadh04/Users/tox.rst
+++ b/tmp/tmpiwjadh04/Users/tox.rst
@@ -25,7 +25,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
Note:
You can also try generating a tox.ini file automatically, by running tox-quickstart |
|
Comment on 9832fdf, file Users/tox.rst, line 82. (INFO/1) Hyperlink target "tox-sections" is not referenced. Origin: RSTcheckBear, Section: |
|
Comment on 6fae468, file Users/tox.rst, line 12. Line contains following spacing inconsistencies:
Origin: SpaceConsistencyBear, Section: The issue can be fixed by applying the following patch: --- a/tmp/tmpcjm1qi87/Users/tox.rst
+++ b/tmp/tmpcjm1qi87/Users/tox.rst
@@ -9,7 +9,7 @@
taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__.
-Basic example.
+Basic example.
----------------------------------------------------------------
First, install tox with pip install tox. Then put basic information about your project and the test
environments you want your project to run in into a tox.ini file residing right next to your setup.py file: |
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: 4ade1070-f0ee-11e8-a427-d38b467abfda |
Users/tox.rst
Outdated
| =============== | ||
| tox is a generic virtualenv management and test command line tool you can use for: | ||
|
|
||
| - checking your package installs correctly with different Python versions and interpreters |
There was a problem hiding this comment.
(ERROR/3) Content block expected for the "Note" directive; none found.
Origin: RSTcheckBear, Section: rstcheck.
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: ae7b50c0-f0ee-11e8-a427-d38b467abfda |
Users/tox.rst
Outdated
|
|
||
| taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__. | ||
|
|
||
| Basic example. |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpzda9erje/Users/tox.rst
+++ b/tmp/tmpzda9erje/Users/tox.rst
@@ -9,7 +9,7 @@
taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__.
-Basic example.
+Basic example.
----------------------------------------------------------------
First, install tox with pip install tox. Then put basic information about your project and the test
environments you want your project to run in into a tox.ini file residing right next to your setup.py file:
| # whatever extra steps before testing might be necessary | ||
| pytest # or any other test runner that you might use | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
(ERROR/3) Content block expected for the "note" directive; none found.
Origin: RSTcheckBear, Section: rstcheck.
| # whatever extra steps before testing might be necessary | ||
| pytest # or any other test runner that you might use | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
(ERROR/3) Content block expected for the "note" directive; none found.
Origin: RSTcheckBear, Section: rstcheck.
|
Comment on 9832fdf, file Users/tox.rst, line 28. Line contains following spacing inconsistencies:
Origin: SpaceConsistencyBear, Section: The issue can be fixed by applying the following patch: --- a/tmp/tmpiwjadh04/Users/tox.rst
+++ b/tmp/tmpiwjadh04/Users/tox.rst
@@ -25,7 +25,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
Note:
You can also try generating a tox.ini file automatically, by running tox-quickstart |
|
Comment on 9832fdf, file Users/tox.rst, line 82. (INFO/1) Hyperlink target "tox-sections" is not referenced. Origin: RSTcheckBear, Section: |
|
Comment on 6fae468, file Users/tox.rst, line 12. Line contains following spacing inconsistencies:
Origin: SpaceConsistencyBear, Section: The issue can be fixed by applying the following patch: --- a/tmp/tmpcjm1qi87/Users/tox.rst
+++ b/tmp/tmpcjm1qi87/Users/tox.rst
@@ -9,7 +9,7 @@
taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__.
-Basic example.
+Basic example.
----------------------------------------------------------------
First, install tox with pip install tox. Then put basic information about your project and the test
environments you want your project to run in into a tox.ini file residing right next to your setup.py file: |
Users/tox.rst
Outdated
| - running your tests in each of the environments, configuring your test tool of choice | ||
| - acting as a frontend to Continuous Integration servers, greatly reducing boilerplate and merging CI and shell-based testing. | ||
|
|
||
| taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__. |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpke001i3e/Users/tox.rst
+++ b/tmp/tmpke001i3e/Users/tox.rst
@@ -24,7 +24,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
.. Note ::
You can also try generating a tox.ini file automatically, by running tox-quickstart
Users/tox.rst
Outdated
|
|
||
| Basic example. | ||
| ---------------------------------------------------------------- | ||
| First, install tox with pip install tox. Then put basic information about your project and the test |
There was a problem hiding this comment.
Line is longer than allowed. (83 > 79)
Origin: LineLengthBear, Section: docs.
| - acting as a frontend to Continuous Integration servers, greatly reducing boilerplate and merging CI and shell-based testing. | ||
|
|
||
| taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__. | ||
|
|
There was a problem hiding this comment.
(ERROR/3) Content block expected for the "Note" directive; none found.
Origin: RSTcheckBear, Section: rstcheck.
|
Comment on 6fae468, file Users/tox.rst, line 12. Line contains following spacing inconsistencies:
Origin: SpaceConsistencyBear, Section: The issue can be fixed by applying the following patch: --- a/tmp/tmpcjm1qi87/Users/tox.rst
+++ b/tmp/tmpcjm1qi87/Users/tox.rst
@@ -9,7 +9,7 @@
taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__.
-Basic example.
+Basic example.
----------------------------------------------------------------
First, install tox with pip install tox. Then put basic information about your project and the test
environments you want your project to run in into a tox.ini file residing right next to your setup.py file: |
Users/tox.rst
Outdated
| - acting as a frontend to Continuous Integration servers, greatly reducing boilerplate and merging CI and shell-based testing. | ||
|
|
||
|
|
||
| taken from `tox.readthedocs.io <https://tox.readthedocs.io/en/latest/>`__. |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpcjm1qi87/Users/tox.rst
+++ b/tmp/tmpcjm1qi87/Users/tox.rst
@@ -28,7 +28,7 @@
Note:
-You can also try generating a tox.ini file automatically, by running tox-quickstart
+You can also try generating a tox.ini file automatically, by running tox-quickstart
and then answering a few simple questions.
To sdist-package, install and test your project against Python2.7 and Python3.6, just type:
|
|
||
| - ``purge`` : This section contains commands that only run for scenarios | ||
| that purge the cluster and redeploy. You'll see this section being reused in | ||
| ``testenv``with the following syntax: ``{[purge]commands}`` |
There was a problem hiding this comment.
(WARNING/2) Definition list ends without a blank line; unexpected unindent.
Origin: RSTcheckBear, Section: rstcheck.
|
Comment on 9832fdf, file Users/tox.rst, line 82. (INFO/1) Hyperlink target "tox-sections" is not referenced. Origin: RSTcheckBear, Section: |
|
|
||
| To sdist-package, install and test your project against Python2.7 and | ||
| Python3.6, just type: | ||
|
|
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmp7bj7i79f/Users/tox.rst
+++ b/tmp/tmp7bj7i79f/Users/tox.rst
@@ -33,7 +33,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
Note
You can also try generating a tox.ini file automatically, by running
Users/tox.rst
Outdated
| otherwise you will see errors). When you run tox a second time you’ll note | ||
| that it runs much faster | ||
| because it keeps track of virtualenv details and will not recreate or | ||
| re-install dependencies. |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmp7bj7i79f/Users/tox.rst
+++ b/tmp/tmp7bj7i79f/Users/tox.rst
@@ -39,7 +39,7 @@
You can also try generating a tox.ini file automatically, by running
tox-quickstart and then answering a few simple questions.
-To sdist-package, install and test your project against Python2.7 and
+To sdist-package, install and test your project against Python2.7 and
Python3.6, just type:
::
| is used to define the Ceph release (``{jewel,kraken,rhcs}-...``). To add | ||
| luminous you'd change that to look like ``{luminous,kraken,rhcs}-...``. | ||
| In the ``testenv`` section | ||
| this is a subsection called ``setenv`` which allows you to provide environment |
There was a problem hiding this comment.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
There was a problem hiding this comment.
Fix your PR per gitmate-bot's review.
Squash your commits. See https://coala.io/commit
This file ensures that coala is successfully installed in tox properly. Closes coala#344
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: 1ff346a0-f896-11e8-a3fa-23497f13c755 |
| commands = | ||
| # whatever extra steps before testing might be necessary | ||
| pytest # or any other test runner that you might use | ||
|
|
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpv5iq47vm/Users/tox.rst
+++ b/tmp/tmpv5iq47vm/Users/tox.rst
@@ -32,7 +32,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
.. note::
You can also try generating a tox.ini file automatically, by running
| :: | ||
|
|
||
| tox | ||
|
|
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpv5iq47vm/Users/tox.rst
+++ b/tmp/tmpv5iq47vm/Users/tox.rst
@@ -43,7 +43,7 @@
::
tox
-
+
.. note::
and watch things happening (you must have python2.7 and python3.6
|
|
||
| .. note:: | ||
|
|
||
| and watch things happening (you must have python2.7 and python3.6 |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpv5iq47vm/Users/tox.rst
+++ b/tmp/tmpv5iq47vm/Users/tox.rst
@@ -46,7 +46,7 @@
.. note::
- and watch things happening (you must have python2.7 and python3.6
+ and watch things happening (you must have python2.7 and python3.6
installed in your environment otherwise you will see errors). When
you run tox a second time you’ll note that it runs much faster
because it keeps track of virtualenv details and will not recreate or
|
|
||
| - ``testenv`` : This is the main section of the ``tox.ini`` file and is run | ||
| on every scenario. This section contains many *factors* that define | ||
| conditional settings depending on the scenarios defined in the |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpv5iq47vm/Users/tox.rst
+++ b/tmp/tmpv5iq47vm/Users/tox.rst
@@ -75,7 +75,7 @@
- ``testenv`` : This is the main section of the ``tox.ini`` file and is run
on every scenario. This section contains many *factors* that define
- conditional settings depending on the scenarios defined in the
+ conditional settings depending on the scenarios defined in the
``envlist``.
For example, the factor``centos7_cluster`` in the ``changedir`` subsection
of ``testenv`` sets the directory that tox will change do when that factor
| more information on how the ``envlist`` works. | ||
|
|
||
| - ``purge`` : This section contains commands that only run for scenarios | ||
| that purge the cluster and redeploy. You'll see this section being reused in |
There was a problem hiding this comment.
Line is longer than allowed. (80 > 79)
Origin: LineLengthBear, Section: docs.
|
|
||
| - ``purge`` : This section contains commands that only run for scenarios | ||
| that purge the cluster and redeploy. You'll see this section being reused in | ||
| ``testenv``with the following syntax: ``{[purge]commands}`` |
There was a problem hiding this comment.
(WARNING/2) Definition list ends without a blank line; unexpected unindent.
Origin: RSTcheckBear, Section: rstcheck.
Travis tests have failedHey @ManthanKeim, 1st Buildmake html SPHINXOPTS=-WTravisBuddy Request Identifier: 7a704100-f896-11e8-a3fa-23497f13c755 |
| commands = | ||
| # whatever extra steps before testing might be necessary | ||
| pytest # or any other test runner that you might use | ||
|
|
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpez36okvv/Users/tox.rst
+++ b/tmp/tmpez36okvv/Users/tox.rst
@@ -32,7 +32,7 @@
commands =
# whatever extra steps before testing might be necessary
pytest # or any other test runner that you might use
-
+
.. note::
You can also try generating a tox.ini file automatically, by running
| :: | ||
|
|
||
| tox | ||
|
|
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpez36okvv/Users/tox.rst
+++ b/tmp/tmpez36okvv/Users/tox.rst
@@ -43,7 +43,7 @@
::
tox
-
+
.. note::
and watch things happening (you must have python2.7 and python3.6
|
|
||
| .. note:: | ||
|
|
||
| and watch things happening (you must have python2.7 and python3.6 |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpez36okvv/Users/tox.rst
+++ b/tmp/tmpez36okvv/Users/tox.rst
@@ -46,7 +46,7 @@
.. note::
- and watch things happening (you must have python2.7 and python3.6
+ and watch things happening (you must have python2.7 and python3.6
installed in your environment otherwise you will see errors). When
you run tox a second time you’ll note that it runs much faster
because it keeps track of virtualenv details and will not recreate or
|
|
||
| - ``testenv`` : This is the main section of the ``tox.ini`` file and is run | ||
| on every scenario. This section contains many *factors* that define | ||
| conditional settings depending on the scenarios defined in the |
There was a problem hiding this comment.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpez36okvv/Users/tox.rst
+++ b/tmp/tmpez36okvv/Users/tox.rst
@@ -75,7 +75,7 @@
- ``testenv`` : This is the main section of the ``tox.ini`` file and is run
on every scenario. This section contains many *factors* that define
- conditional settings depending on the scenarios defined in the
+ conditional settings depending on the scenarios defined in the
``envlist``.
For example, the factor``centos7_cluster`` in the ``changedir`` subsection
of ``testenv`` sets the directory that tox will change do when that factor
| more information on how the ``envlist`` works. | ||
|
|
||
| - ``purge`` : This section contains commands that only run for scenarios | ||
| that purge the cluster and redeploy. You'll see this section being reused in |
There was a problem hiding this comment.
Line is longer than allowed. (80 > 79)
Origin: LineLengthBear, Section: docs.
|
|
||
| - ``purge`` : This section contains commands that only run for scenarios | ||
| that purge the cluster and redeploy. You'll see this section being reused in | ||
| ``testenv``with the following syntax: ``{[purge]commands}`` |
There was a problem hiding this comment.
(WARNING/2) Definition list ends without a blank line; unexpected unindent.
Origin: RSTcheckBear, Section: rstcheck.
tox.rst explains how to set up coala in tox properly.
closes #344
For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!
Checklist
them.
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!
After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.
Please consider helping us by reviewing other peoples pull requests as well:
corobo mark wip <URL>to get it outof the review queue.
The more you review, the more your score will grow at coala.io and we will
review your PRs faster!