This repository has been archived by the owner on Jul 3, 2024. It is now read-only.
doc: fix an error if the doc is not generated from github #598
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
The commit 57c45c0 expect Sphinx to find the environment variable RELEASE_TAG. It seems it's only the case when the documentation is generated from github using the workflow defined in the release.yml file. This commit allows to generate the doc from outside github, by setting version to the current commit id if we are on a git repository, and "n/a" otherwise.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The commit 57c45c0 expect Sphinx to find the environment variable
RELEASE_TAG.
It seems it's only the case when the documentation is generated from
github using the workflow defined in the release.yml file.
This commit allows to generate the doc from outside github, by setting
version to the current commit id if we are on a git repository, and
"n/a" otherwise.