SMTG-Bham / ThermoParser

A tool for streamlining data analysis and visualisation for thermoelectrics and charge carrier transport in computational materials science.
https://smtg-bham.github.io/ThermoParser/
GNU Affero General Public License v3.0
47 stars 15 forks source link

[joss review] Dependencies for building the documentation #80

Closed fnattino closed 8 months ago

fnattino commented 8 months ago

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 setuptools extras_require field.

For instance, you could add to setup.py:

setup(
  ...
  extras_require={
    "docs"=["sphinx", "sphinx_rtd_theme"]
  }
  ...
)

to be able to install docs-related dependencies using: pip install .[docs]

JOSS review issue

kbspooner commented 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.

fnattino commented 8 months ago

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?

kbspooner commented 8 months ago

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!