Contributing¶
Dev setup¶
To install the development dependencies, clone the package from Github, and run within the folder:
pip install -e ".[dev]"
You can then run the tests from the root folder:
pytest
You can also run the tests against multiple pythons:
tox
Note that this invocation is expected to fail in the coverage upload stage (it needs access token to upload coverage report)
To build the documentation, run make html
from the docs folder:
cd docs
make html
Then you can run a static HTML server from docs/build/html
.
cd build/html
python -m http.server