Changelog

Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Fixed CHANGELOG format to let mindsers/changelog-reader-action recognise version number correctly
Updated mkdocs and urllib3 versions
mkdocs - added light/dark mode toggle, navigation improvements
mike - added multiple documentation versions support
tox - added conda support (for multiple python versions)
urllib3 - removed certain security vulnerabilities
Replaced testing with mike, rather than mkdocs
Updated tests to remove warnings from pytest-cookies
Added tests to ensure template get built correctly
Updated and cleaned up documentations
Removed optionality for mypy and pre-commit
Removed support for py36

first release with the following features:

Poetry: Manage dependency, build and release
Mkdocs: Writing your docs in markdown style
Testing with Pytest (unittest is still supported out of the box)
Code coverage report and endorsed by Codecov
Tox: Test your code against environment matrix, lint and artifact check
Format with Black and Isort
Lint code with Flake8 and Flake8-docstrings
Check static type with Mypy (optional)
Pre-commit hooks: Formatting/linting anytime when commit your code
Mkdocstrings: Auto API doc generation
Command line interface using Click (optional)
bump2version: Pre-configured version bumping with a single command
Continuous Integration/Deployment by GitHub actions, includes:
- publish dev build/official release to TestPyPI/PyPI automatically when CI success
- publish documents automatically when CI success
- extract changelog from CHANGELOG and integrate with release notes automatically
Host your documentation from GitHub Pages with zero-config

Last update: 2021-12-20