Show precise versions for stable and development ("latest") #16
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
tsibley
force-pushed
the
trs/precise-versions
branch
from
9e5cdba to
2b4322a
Compare
Make it even clearer what software revisions those labels represent.
A `git describe` style string¹ for development ("latest") would be even
better than just the git revision, but that appears to be non-trivial to
implement.
Resolves <nextstrain/augur#817>.
h/t to @corneliusroemer for the suggestion and @huddlej for bringing it
up again in <#15>.
¹ e.g. "${tag}-${n}-g${sha}" where ${tag} is the last/closest tag to the
current commit, ${n} is the number of commits since that ${tag}, and
${sha} is the shortened id of the current commit.
tsibley
force-pushed
the
trs/precise-versions
branch
from
2b4322a to
ffac8ee
Compare
tsibley
changed the title
huddlej
reviewed
Jan 29, 2022
|
Yeah, https://github.com/nextstrain/readthedocs-testbed and https://readthedocs-testbed.readthedocs.org are new to test out this PR (but I expect to find use for them in future work too). These changes should work across our real projects with one caveat: the precise version in "stable version (X)" can only be shown if the project's Sphinx Augur currently doesn't define |
tsibley
added a commit
to nextstrain/augur
that referenced
this pull request
Jan 29, 2022
This will allow us to display the specific version for "stable" on Read the Docs (once <nextstrain/sphinx-theme#16> is merged). Also sets "release" as the Sphinx documentation says¹: If you don’t need the separation provided between version and release, just set them both to the same value. ¹ https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-release
victorlin
approved these changes
Feb 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Make it even clearer what software revisions those labels represent.
A
git describestyle string1 for development ("latest") would be even better than just the git revision, but that appears to be non-trivial to implement.Resolves nextstrain/augur#817.
h/t to @corneliusroemer for the suggestion and @huddlej for bringing it up again in #15.
Footnotes
e.g. "${tag}-${n}-g${sha}" where ${tag} is the last/closest tag to the current commit, ${n} is the number of commits since that ${tag}, and ${sha} is the shortened id of the current commit. ↩