Use mkdocs extension mike to build versioned docs#132
Merged
JaroCamphuijsen merged 9 commits intomainfrom Jan 20, 2026
Merged
Conversation
Contributor
Author
|
The development workflow seems to work properly, as can be seen from this page. If we merge this PR, we can test the release workflow by making a patch release. |
|
raar1
approved these changes
Jan 19, 2026
Collaborator
raar1
left a comment
raar1
left a comment
There was a problem hiding this comment.
Great work Jaro, this is something we've needed for ages. Very nice that you retro'd the older versions in too :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uses the "mike" python utility to setup versioning for mkdocs (https://github.com/jimporter/mike) and the mkdocs-materials extension to integrate it with mkdocs (https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/).
The currently published documentation is produced with mike (see the version dropdown). And CI workflows have been changed/added to provide for automated docs deployment on releases and for development purposes.
The deployed "develop" version of the docs are currently updated on a PR merge to main, creation of a PR to main and manually on a workflow dispatch. I suggest to only run this on merges to main (although a workflow dispatch might be useful) so it will (usually) reflect the main branch's state.
fix #115