Code peer review and reformatting/styling by @amyheather and creation of great-docs documentation site.
Added
- Add
CONTRIBUTING.md. - Add
all-contributors. - Add
great-docsdocumentation site. - Add GitHub actions to check for alt-text, deploy documentation, check for linting issues, and run tests.
- Add some basic smoke tests.
Changed
- Set package to require Python 3.11+ as that is required by
great-docs. - Environment:
- Add
great-docsandruff. - Removed
jupyter,nbqa,blackandflake8.
- Add
- Examples: converted from
.ipynbto.qmd, stored inuser_guide/, and moved the explanation to a separate page in the guide, so these now contain less duplicate information. README: tidy up, remove jupyter-lab instructions, remove diagram as easy to go stale.- Citation: add @amyheather.
- Style: Linting and formatting package, tests and documentation to be compliant with a wide range of ruff rules.
Fixed
- Amended
ProcessModel.to_mermaidto only return Mermaid, not markdown, as that was very jupyter-specific and didn't work in quarto site.