[x] Fully documented, including HISTORY.rst for all changes
and one of the docs/*-api.rst files for new API
Howto run test cases and lint the code base
```bash
$ py.test --flake8 -v -s tricolour
```
If you encounter flake8 failures, a quick way to correct
this is to run `autopep8` and `flake8` again.
```bash
$ pip install -U autopep8
$ autopep8 -r -i tricolour
$ flake8 tricolour
```
Howto build the documentation
To build the docs locally:
```bash
$ pip install -r requirements.readthedocs.txt
$ cd docs
$ READTHEDOCS=True make html
```
sjperkins
commented
3 years ago
HISTORY.rstfor all changes and one of thedocs/*-api.rstfiles for new APIHowto run test cases and lint the code base
```bash $ py.test --flake8 -v -s tricolour ``` If you encounter flake8 failures, a quick way to correct this is to run `autopep8` and `flake8` again. ```bash $ pip install -U autopep8 $ autopep8 -r -i tricolour $ flake8 tricolour ```Howto build the documentation
To build the docs locally: ```bash $ pip install -r requirements.readthedocs.txt $ cd docs $ READTHEDOCS=True make html ```