Add GitPython to "docs" optional deps #729
Merged
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 was missed in #719. It is required during the Sphinx docs build, in order for the
ixmp.utils.sphinx_linkcode_github
extension to identify the branch name to link, in both:This issue was/is not visible on the CI workflow job on the PR branch, because in that case the explicitly supplied head_ref is used:
message_ix/.github/workflows/pytest.yaml
Lines 127 to 131 in 4034d8c
The added dependency mirrors ixmp; in the ixmp CI the extension is working properly.
How to review
See the log of this example build from the current branch. In the final step, the 4th line of output is:
This indicates the branch is correctly identified using GitPython.
PR checklist
Add or expand tests;coverage checks both ✅Add, expand, or update documentation.N/AUpdate release notes.