use the UMF version from git describe in docs, not the harcoded one #1027
Conversation
This file contains hidden or 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
lplewa
reviewed
Jan 8, 2025
docs/config/conf.py
Outdated
| # The full version, including alpha/beta/rc tags | ||
| release = "0.11.0" | ||
|
|
||
| release = os.getenv("UMF_VERSION", "unknown") |
Contributor
There was a problem hiding this comment.
any fallback if version is not set? i.e. docs are build localy without CI??
Contributor
Author
There was a problem hiding this comment.
I have added an appropriate message to set the UMF_VERSION
bratpiorka
force-pushed
the
rrudnick_umf_ver_docs
branch
from
0431700 to
ad37472
Compare
PatKamin
reviewed
Jan 8, 2025
PatKamin
approved these changes
Jan 8, 2025
bratpiorka
force-pushed
the
rrudnick_umf_ver_docs
branch
2 times, most recently
from
de78b8c to
38c5094
Compare
lplewa
approved these changes
Jan 9, 2025
docs/README.md
Outdated
| To display the proper version of UMF in the documentation title, set the `UMF_VERSION` variable before running the script. | ||
|
|
||
| ```bash | ||
| $ UMF_VERSION=<your version, e.g. "0.12.1"> python ./docs/generate_docs.py |
Contributor
There was a problem hiding this comment.
heh, just a few lines above we say it has to be run from any sub-dir, and here you suggest it can be run from the root dir of the repo - pls update the example :)
bratpiorka
force-pushed
the
rrudnick_umf_ver_docs
branch
from
38c5094 to
4d9e2a5
Compare
ldorau
approved these changes
Jan 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
use the UMF version from git describe in docs, not the harcoded one
logs from the workflow on my fork:
https://github.com/bratpiorka/unified-memory-framework/actions/runs/12667121286/job/35299837634
built docs:
https://bratpiorka.github.io/unified-memory-framework/
fixes: #1024