Skip to content

Conversation

paddy74
Copy link
Owner

@paddy74 paddy74 commented Oct 1, 2025

This PR configures MkDocs as the project's documentation site, including referencing existing .md files and docstrings.

  • Initialize MkDocs
  • Create MkDocs plugin mkdocs-external-files
  • Extend mkdocs.yaml with hooks.py
  • Add additional properties to _version.py
  • Automate publication to GitHub Pages using .github/workflows/docs.yaml
  • Add badges to the README.md

@paddy74 paddy74 self-assigned this Oct 1, 2025
@paddy74 paddy74 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 1, 2025
@paddy74 paddy74 merged commit 64ed1dc into main Oct 1, 2025
6 checks passed
@paddy74 paddy74 deleted the docs/mkdocs branch October 1, 2025 02:43
@paddy74 paddy74 linked an issue Oct 1, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Package documentation is continuously published

1 participant