v0.2.0
v0.2.0 (2024-05-16)
Ci
- ci: setup release pipeline (#42)
release.yml configures the github workflow to lint the commit message, format of the code,
and the unit tests. After successfully completing those jobs, the pipeline builds the package,
updates the semantic version according to the commit message and publishes to the GitHub
Release as well as to the PyPi.
- ci: setup pr github workflow (#40)
Combined the black, commit-message-lint, and the unit test workflow into one called ci.yml. This is beneficial because it could be reused in the release pipeline.
Documentation
- docs: add quarto and quartodoc for static website (#38)
_quarto.yml includes the base structure of the static website with a navbar and the main site. The navbar includes 'Overview', 'Get Started', and 'API Referece' sections, which are structured in _index.qmd, _get_started.qmd, and the quartodoc section of _quarto.yml respectively. Currently, the 'Overview' and 'Get Started' sections are left empty, which will be generated in the upcoming releases. The 'API Reference' section will include the docstring in a neat format generated by quartodoc.