Add tox and remove pytest from extra requirements #1195
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1195 +/- ##
=======================================
Coverage ? 96.98%
=======================================
Files ? 71
Lines ? 7023
Branches ? 0
=======================================
Hits ? 6811
Misses ? 212
Partials ? 0 Continue to review full report at Codecov.
|
|
@rocco8773 — my apologies for this one since I am afear'd that the code review for this will be more drawn out and time-consuming than any we have had to deal with for the last seventeen millenia in two separate multiverses. |
changelog/1195.trivial.rst
Outdated
| @@ -0,0 +1 @@ | |||
| Added tox as an extra requirement. | |||
There was a problem hiding this comment.
| Added tox as an extra requirement. | |
| Added `tox <https://tox.readthedocs.io/en/latest/>`_ as an extra requirement. |
I really want to make you add tox to the intersphinx_mappings so this auto cross-references, but not necessary. 🤣
There was a problem hiding this comment.
Using intersphinx isn't a bad idea here since tox will come up in a bunch of places in the development guide.
| @@ -7,3 +7,4 @@ numba | |||
| numba-scipy | |||
| pytest >= 5.1 | |||
| setuptools_scm | |||
| tox | |||
There was a problem hiding this comment.
As per the comment at the top of this file, the associated section in the setup.cfg also needs to be updated.
There was a problem hiding this comment.
Good thing we have that comment there so I don't forget to do things like that! 😸
namurphy
changed the title
It is not in options.extras_require, and it is already in the requirements for testing.
namurphy
changed the title
| @@ -5,5 +5,5 @@ lmfit | |||
| mpmath | |||
| numba | |||
| numba-scipy | |||
| pytest >= 5.1 | |||
There was a problem hiding this comment.
I tentatively removed pytest from extras.txt since it was not included in options.extras_require and since it is already included in the testing requirements.
There was a problem hiding this comment.
Weird. That probably shouldn't have been there in the first place.
changelog/1195.doc.rst
Outdated
| @@ -0,0 +1 @@ | |||
| Added `tox` to intersphinx. | |||
There was a problem hiding this comment.
| Added `tox` to intersphinx. | |
| Added `tox <https://tox.readthedocs.io/en/latest/>`_ to the :confval:`intersphinx_mapping` configuration value in PlasmaPy's ``conf.py``. |
See my comment about the tox documentation not being fully indexed.
Co-authored-by: Erik Everson <[email protected]>
The tox docs are not set up correctly for intersphinx.
namurphy
changed the title
|
I applied my favorite word "downscope" to this PR, and removed the parts about adding tox to intersphinx since they don't have it set up correctly. |
| @@ -80,7 +80,7 @@ | |||
| "https://sphinx-automodapi.readthedocs.io/en/latest/", | |||
| None, | |||
| ), | |||
| "spihnx": ("https://www.sphinx-doc.org/en/master/", None), | |||
| "sphinx": ("https://www.sphinx-doc.org/en/master/", None), | |||
There was a problem hiding this comment.
Would dot be surprised if that was my typo. 🤣🤦♂️
Following this discussion in #1156, this PR adds tox to
requirements/extras.txtsince it's used a lot in tests and such.