Summary
This release focuses on improving the automation by publishing to PyPI (for built package across multiple platforms and python versions) and ReadTheDocs/GitHub Pages for documentation.
In addition a number of improvements have been made to the documentation and some ground work laid down for a worked tutorial example and improved validation / testing of the codebase.
๐ Features
- Build wheels using `cibuildwheel` prior to releasing to PyPI Liam-Deacon (70)
- Track test coverage Liam-Deacon (72)
- Update README to use GitHub-flavored markdown Liam-Deacon (71)
- Add pre-commit config Liam-Deacon (69)
๐ Bug Fixes
- Fix mac builds Liam-Deacon (65)
- Address install-deps typo Liam-Deacon (60)
- Change gh pages deploy if condition to check against master instead of main Liam-Deacon (49)
๐งฐ Maintenance
- bump patch version to 0.1.8 Liam-Deacon (73)
- Merge linux jobs Liam-Deacon (63)
- Do not upload release when testing Liam-Deacon (61)
- Update .gitignore for correct docs/ build dir Liam-Deacon (50)
:construction_worker: Continuous Integration
- Build wheels using `cibuildwheel` prior to releasing to PyPI Liam-Deacon (70)
- Track test coverage Liam-Deacon (72)
- Add pre-commit config for automated PR checks Liam-Deacon (69)
- Allow test releases of PyPI publishing and remove environments
Liam-Deacon (59)
- Configure publishing to ReadTheDocs using `.readthedocs.yaml` Liam-Deacon (54, 53, 52)
:books: Documentation
- Update README to use GitHub-flavored markdown Liam-Deacon (71)
- Prepare for https://mybinder.org tutorial use Liam-Deacon (#68)
- add pre-commit config Liam-Deacon (69)
- Update documentation Liam-Deacon (51)
- Publish to GitHub pages Liam-Deacon (49)
๐งช Testing
- Track test coverage Liam-Deacon (72)
- Add pre-commit checks Liam-Deacon (69)
Other Changes
- Pin `sphinx_rtd_theme` to latest version 2.0.0 pyup-bot (55)
- Pin `numpydoc` to latest version 1.6.0 pyup-bot (56)