Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 536 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 536 Bytes

Mini contribution guide

The package uses pyproject.toml and Poetry. To install the dependencies:

$ poetry install --extras "docs"

Tests

To run tests with the current Python version:

$ poetry run pytest

To run tests with all supported Python versions:

$ poetry run tox

Docs

To build the docs, use Sphinx:

$ poetry run sphinx-build docs docs/_build

Then, browse from docs/_build/index.html.