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

Update to allow for versioning #82

Merged
merged 3 commits into from
Feb 20, 2025
Merged

Update to allow for versioning #82

merged 3 commits into from
Feb 20, 2025

Conversation

bparks13
Copy link
Member

This PR adds a dropdown menu to the TOC on the left where the user can choose which version of the docs they wish to view. This also adds a redirect page from the old base URL, since the folder structure of the docs is now nested to allow for multiple versions to be hosted.

- Allows for sphinx-multiversion to run on all previous tags and the main branch
- Add dropdown menu of available versions
- Update Makefile
- Update actions
- Add redirect page
- Add documentation
@bparks13 bparks13 requested a review from jonnew February 19, 2025 19:22
@bparks13 bparks13 self-assigned this Feb 19, 2025
@bparks13
Copy link
Member Author

@jonnew Currently, this PR will redirect to the main branch (which is now the V2 pre-release) automatically when the page is loaded. Should we redirect it to the v1.0 tag instead?

- Made logo a bit tighter so it was not so far away
Copy link
Member

@jonnew jonnew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good.

  • I moved the selection drop down the navbar
  • I'm hoping we can rename "main" to "v2.0-beta" or "dev"

- Also, change the redirect to point to v1.0 docs
@jonnew jonnew merged commit 9a50996 into main Feb 20, 2025
1 check passed
@jonnew jonnew deleted the issue-69 branch February 20, 2025 21:26
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.

Add versioning
2 participants