Closed fnattino closed 8 months ago
Ahh this is handy, I've done this for the docs and the tests and updated the relevent docs sections, currently in the bug-fix branch.
Great, nice setup! Concerning the tests: I think unittest
is already part of the standard library, you should not need any additional dependency to run tests via python -m unittest
, correct? Also note the different spelling of the unitest
package you have now as extra dependency (only one "t"), not sure whether this is actually needed?
Ahh is that what happened. I got an error when I tried to install unittest, presumably because its built-in as you say, and it suggested unitest instead, so I blindly followed. I think I've done that before actually, but I will remember next time! Thanks!
In order to build the documentation, the package
sphinx_rtd_theme
is required in addition to sphinx, but not mentioned anywhere.Also, sphinx is listed as part of the
requirements.txt
file, but you might consider creating instead a dependency set dedicated to building the documentation. See e.g. the setuptoolsextras_require
field.For instance, you could add to
setup.py
:to be able to install docs-related dependencies using:
pip install .[docs]
JOSS review issue