-
Notifications
You must be signed in to change notification settings - Fork 12
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
Utilize doc version switcher #106
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WardBrian
added
documentation
Improvements or additions to documentation
github_actions
Pull requests that update GitHub Actions code
labels
Apr 18, 2023
roualdes
approved these changes
Apr 18, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea. The changes look good to me, in my novice github workflow opinion.
Updates should be live. https://roualdes.github.io/bridgestan will redirect to https://roualdes.github.io/bridgestan/latest, and the new drop down is visible in the top right |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
github_actions
Pull requests that update GitHub Actions code
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.
This is something I've been thinking about since we merged #91 and #98 but haven't yet had a release: our online docs have updated to the latest API, but people who download/use it right now won't have that necessarily.
Obviously one fix is to always be prompt on releasing new code, but I think a better solution involves a more complete documentation site. Our theme supports version switchers, which we can use to keep multiple versions of the docs around.
This PR does a few things:
main
will now live atroualdes.github.io/bridgestan/latest/
2.0.1
there will be a copy atroualdes.github.io/bridgestan/v2.0.1/
This will all be automated going forward, but the first time through I will need to make some manual changes to the
gh-pages
branch.roualdes.github.io/bridgestan/
toroualdes.github.io/bridgestan/latest/
(easy)