docs: use mike for multiple docs versions on website #150
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.
Changes
Configures the docs site + github action to host multiple versions
One-time set up steps:
mike deploy 2.5 latest -push --update-aliases --branch gh-pages
mike set-default latest
mike deploy dev --push --update-aliases --branch gh-pages
After this is merged into main, from then on the
dev
version will be updated automatically when new commits are merged into main, and thelatest
version will automatically be set to the latest release.Issues
resolves #97
PR Checklist
(
Strikethroughany points that are not applicable.)CHANGELOG.md
with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/