documentation
documentation copied to clipboard
coala
Create tox.rst
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
- [x] I read the commit guidelines and I've followed them.
- [x] I ran coala over my code locally. (All commits have to pass 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:
- pick up any PR at https://coala.io/review
- review it (check https://coala.io/reviewing for more info)
- if you are sure that it needs work, use
corobo mark wip <URL>to get it out of the review queue.
The more you review, the more your score will grow at coala.io and we will review your PRs faster!
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:29:Content block expected for the "note" directive; none found.
make: *** [html] Error 1
TravisBuddy Request Identifier: 0e81ece0-f0db-11e8-a427-d38b467abfda
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency...
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:document isn't included in any toctree
make: *** [html] Error 1
TravisBuddy Request Identifier: c4c81d70-f0eb-11e8-a427-d38b467abfda
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency...
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:document isn't included in any toctree
make: *** [html] Error 1
TravisBuddy Request Identifier: 6c7a7440-f0ed-11e8-a427-d38b467abfda
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 28.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
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 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 12.
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
@@ -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 failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:29:Content block expected for the "Note" directive; none found.
make: *** [html] Error 1
TravisBuddy Request Identifier: 4ade1070-f0ee-11e8-a427-d38b467abfda
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [ 7%] Help/FAQ
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:28:Content block expected for the "Note" directive; none found.
make: *** [html] Error 1
TravisBuddy Request Identifier: ae7b50c0-f0ee-11e8-a427-d38b467abfda
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 28.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
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 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 12.
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
@@ -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:
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 12.
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
@@ -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:
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:28:Content block expected for the "Note" directive; none found.
make: *** [html] Error 1
TravisBuddy Request Identifier: 2930c740-f0f0-11e8-a427-d38b467abfda
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 12.
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
@@ -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:
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Comment on 9e1647ae6e51f2f33a3d32b0f57e32181ec0281f, file Users/tox.rst, line 30.
Line is longer than allowed. (83 > 79)
Origin: LineLengthBear, Section: docs.
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 31.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpiwjadh04/Users/tox.rst
+++ b/tmp/tmpiwjadh04/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:
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 31.
Line is longer than allowed. (84 > 79)
Origin: LineLengthBear, Section: docs.
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency...
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:document isn't included in any toctree
make: *** [html] Error 1
TravisBuddy Request Identifier: 84860f10-f186-11e8-9656-0d921d759fe6
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 12.
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
@@ -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:
Comment on 6fae468c0e0a734b3ce4bafc17f5f13bc3e6ff02, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Comment on 9e1647ae6e51f2f33a3d32b0f57e32181ec0281f, file Users/tox.rst, line 30.
Line is longer than allowed. (83 > 79)
Origin: LineLengthBear, Section: docs.
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 31.
Line contains following spacing inconsistencies:
- Trailing whitespaces.
Origin: SpaceConsistencyBear, Section: docs.
The issue can be fixed by applying the following patch:
--- a/tmp/tmpiwjadh04/Users/tox.rst
+++ b/tmp/tmpiwjadh04/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:
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 31.
Line is longer than allowed. (84 > 79)
Origin: LineLengthBear, Section: docs.
Comment on 9832fdf17d7159a5fb5e21d2cce297242582baa7, file Users/tox.rst, line 82.
(INFO/1) Hyperlink target "tox-sections" is not referenced.
Origin: RSTcheckBear, Section: rstcheck.
Travis tests have failed
Hey @ManthanKeim, Please read the following log in order to understand the failure reason. It'll be awesome if you fix what's wrong and commit the changes.
1st Build
make html SPHINXOPTS=-W
sphinx-build -b html -d _build/doctrees -W . _build/html
Running Sphinx v1.6.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... [100%] index
Warning, treated as error:
/home/travis/build/coala/documentation/Users/tox.rst:36:Content block expected for the "Note" directive; none found.
make: *** [html] Error 1