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 plugin for multiple versions on website #170

Merged
merged 6 commits into from
Jan 18, 2024

Conversation

kelly-sovacool
Copy link
Member

@kelly-sovacool kelly-sovacool commented Jan 17, 2024

Changes

This will help users find the correct version of the documentation.
The website will point to the latest release instead of the dev version by default, and you can select the version to view from a dropdown menu.

  • Configure the mike plugin for mkdocs
  • Add steps to the docs action to determine the version and alias of the docs build.

Issues

NA

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • [ ] Write unit tests for any new features, bug fixes, or other code changes. testing framework not yet implemented
  • [ ] Update docs if there are any API changes. on hold until before public release
  • [ ] If a new nextflow process is implemented, define the process container and stub.
  • 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/

@kelly-sovacool kelly-sovacool self-assigned this Jan 17, 2024
@kelly-sovacool kelly-sovacool merged commit 34e715d into main Jan 18, 2024
1 of 3 checks passed
@kelly-sovacool kelly-sovacool deleted the mike-mkdocs branch January 18, 2024 15:12
@kelly-sovacool kelly-sovacool added this to the Jan 2024 milestone Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant