v0.1.8

[Liam-Deacon]

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 (feat: Build wheels using cibuildwheel prior to releasing to PyPI  #70)
• Track test coverage @Liam-Deacon (test: Track test coverage #72)
• Update README to use GitHub-flavored markdown @Liam-Deacon (doc: Update README to use GitHub-flavored markdown #71)
• Add pre-commit config @Liam-Deacon (feat: add pre-commit config #69)

🐛 Bug Fixes

• Fix mac builds @Liam-Deacon (fix: Attempt to fix mac builds #65)
• Address install-deps typo @Liam-Deacon (fix: Address install-deps typo #60)
• Change gh pages deploy if condition to check against master instead of main @Liam-Deacon (fix: Change gh pages deploy if condition to check against master instead of main #49)

🧰 Maintenance

• bump patch version to 0.1.8 @Liam-Deacon (chore: bump patch version to 0.1.8 #73)
• Merge linux jobs @Liam-Deacon (refactor: Merge linux jobs #63)
• Do not upload release when testing @Liam-Deacon (chore: Do not upload release when testing #61)
• Update .gitignore for correct docs/ build dir @Liam-Deacon (chore: Update .gitignore for correct docs/ build dir #50)

👷 Continuous Integration

• Build wheels using cibuildwheel prior to releasing to PyPI @Liam-Deacon (feat: Build wheels using cibuildwheel prior to releasing to PyPI  #70)
• Track test coverage @Liam-Deacon (test: Track test coverage #72)
• Add pre-commit config for automated PR checks @Liam-Deacon (feat: add pre-commit config #69)
• Allow test releases of PyPI publishing and remove environments
  @Liam-Deacon (ci: Allow test releases of PyPI publishing and remove environments  #59)
• Configure publishing to ReadTheDocs using .readthedocs.yaml @Liam-Deacon (ci: Add requirements-doc.txt used for readthedocs build #54, Update .readthedocs.yaml to use requirements.txt #53, ci: Update .readthedocs.yaml to add build dependencies #52)

📚 Documentation

• Update README to use GitHub-flavored markdown @Liam-Deacon (doc: Update README to use GitHub-flavored markdown #71)
• Prepare for https://mybinder.org tutorial use @Liam-Deacon (doc: prepare for mybinder.org tutorial use #68)
• add pre-commit config @Liam-Deacon (feat: add pre-commit config #69)
• Update documentation @Liam-Deacon (doc: update-documentation-0.1.7-release #51)
• Publish to GitHub pages @Liam-Deacon (fix: Change gh pages deploy if condition to check against master instead of main #49)

🧪 Testing

• Track test coverage @Liam-Deacon (test: Track test coverage #72)
• Add pre-commit checks @Liam-Deacon (feat: add pre-commit config #69)

Other Changes

• Pin sphinx_rtd_theme to latest version 2.0.0 @pyup-bot (Pin sphinx_rtd_theme to latest version 2.0.0 #55)
• Pin numpydoc to latest version 1.6.0 @pyup-bot (Pin numpydoc to latest version 1.6.0 #56)

---

This discussion was created from the release v0.1.8.