Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use mike for versioned docs #173

Merged
merged 5 commits into from
Feb 23, 2024
Merged

Use mike for versioned docs #173

merged 5 commits into from
Feb 23, 2024

Conversation

eshwen
Copy link
Owner

@eshwen eshwen commented Feb 23, 2024

https://github.com/jimporter/mike works with MkDocs Material to easily create versioned documentation, which could be useful if there are major API changes between versions and lots of users are still on a legacy version

Local commands required to switch from plain MkDocs to Mike, and rebuild legacy versions of the docs:

mike delete --all
git checkout v0.12.0
poetry add mike
git-changelog -p github -o CHANGELOG.md  # Regenerate now-missing changelog
mike deploy --update-aliases --push 0.12 latest
git checkout v0.13.1
poetry add mike
git-changelog -p github -o CHANGELOG.md  # Update changelog
mike deploy --update-aliases --push 0.13 latest
<push new commits to gh-pages branch>

@github-actions github-actions bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code labels Feb 23, 2024
@eshwen eshwen self-assigned this Feb 23, 2024
@eshwen eshwen added the enhancement New feature or request label Feb 23, 2024
@eshwen eshwen merged commit 2608f72 into main Feb 23, 2024
7 checks passed
@eshwen eshwen deleted the esh-use-mike-docs branch February 23, 2024 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant