Skip to content

febus982/mkdocs-macros-gh-release-changelog

Repository files navigation

mkdocs-macros-gh-release-changelog

Static Badge Stable Version stability-wip

Python tests Maintainability Test Coverage

Checked with mypy Ruff Code style: black security: bandit

Inspired by https://djpugh.github.io/mkdocs_github_changelog

Commands for development

All the common commands used during development can be run using make targets:

  • make dev-dependencies: Install dev requirements
  • make update-dependencies: Update dev requirements
  • make fix: Run code style and lint automatic fixes (where possible)
  • make test: Run test suite against system python version
  • make check: Run tests against all available python versions, code style and lint checks
  • make type, make format, make lint, make bandit: Run the relevant check
  • make docs: Render the mkdocs website locally