Skip to content
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

Add GitPython to "docs" optional deps #729

Merged
merged 1 commit into from
Jul 26, 2023
Merged

Add GitPython to "docs" optional deps #729

merged 1 commit into from
Jul 26, 2023

Conversation

khaeru
Copy link
Member

@khaeru khaeru commented Jul 26, 2023

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:

  • RTD (example failed build here).
  • The "pytest" CI workflow run on a schedule event (example failed job here).

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:

env:
# For pull_request triggers, GitHub creates a temporary merge commit
# with a hash that does not match the head of the branch. Tell it which
# branch to use.
SPHINXOPTS: -D linkcode_github_remote_head=${{ github.head_ref }}

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:

linkcode base URL: https://github.com/iiasa/message_ix/blob/fix/docs-ci

This indicates the branch is correctly identified using GitPython.

PR checklist

  • Continuous integration checks all ✅
  • Add or expand tests; coverage checks both ✅
  • Add, expand, or update documentation. N/A
  • Update release notes.

@khaeru khaeru added the docs Documentation label Jul 26, 2023
@khaeru khaeru added this to the 3.8 milestone Jul 26, 2023
@khaeru khaeru self-assigned this Jul 26, 2023
@glatterf42
Copy link
Member

Thanks, I was about to do the same ;)

@khaeru khaeru requested a review from glatterf42 July 26, 2023 06:37
Copy link
Member

@glatterf42 glatterf42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should pass the tests after merging, so it looks good to me.

@codecov
Copy link

codecov bot commented Jul 26, 2023

Codecov Report

Merging #729 (2e0a9c4) into main (4034d8c) will increase coverage by 0.0%.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #729   +/-   ##
=====================================
  Coverage   94.4%   94.4%           
=====================================
  Files         43      43           
  Lines       3434    3434           
=====================================
+ Hits        3244    3245    +1     
+ Misses       190     189    -1     

see 1 file with indirect coverage changes

@khaeru khaeru merged commit b5e93b7 into main Jul 26, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants