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

docs: use mike for multiple docs versions on website #150

Merged
merged 3 commits into from
Aug 6, 2024

Conversation

kelly-sovacool
Copy link
Member

@kelly-sovacool kelly-sovacool commented Aug 5, 2024

Changes

Configures the docs site + github action to host multiple versions

One-time set up steps:

  • delete all files in gh-pages, commit this
  • check out the previous release tag and run mike deploy 2.5 latest -push --update-aliases --branch gh-pages
  • set the default landing page: mike set-default latest
  • from the main/dev branch, run 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 the latest version will automatically be set to the latest release.

Issues

resolves #97

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • Update docs if there are any API changes.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

@kopardev kopardev added the RENEE RepoName label Aug 5, 2024
@kelly-sovacool kelly-sovacool marked this pull request as ready for review August 5, 2024 19:02
@samarth8392 samarth8392 merged commit 952b9d8 into main Aug 6, 2024
5 checks passed
@samarth8392 samarth8392 deleted the docs-site-versions branch August 6, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RENEE RepoName
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support multiple versions on docs website
3 participants