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

Fix Sphinx nitpicks fron message_ix docs #506

Merged
merged 1 commit into from
Jan 11, 2024
Merged

Conversation

khaeru
Copy link
Member

@khaeru khaeru commented Jan 10, 2024

This PR adjusts some internal intersphinx references.

Where the following would ordinarily be sufficient for an internal reference:

:class:`.Platform`

…this leads to a missing reference when the docstring that contains it is included in the downstream (message_ix) docs.

This PR adjusts some of these references to, for instance:

:class:`.ixmp.Platform`

This has no effect on the appearance of the ixmp docs, but allows the reference target to be correctly identified downstream.

How to review

  • Read the diff and note that the CI checks all pass.

PR checklist

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

@khaeru khaeru self-assigned this Jan 10, 2024
@khaeru khaeru added the docs Documentation, tutorials, etc. label Jan 10, 2024
@khaeru khaeru added this to the 3.8 milestone Jan 10, 2024
@khaeru khaeru requested a review from glatterf42 January 10, 2024 16:15
Copy link

codecov bot commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (be06f38) 98.6% compared to head (9579188) 98.9%.

Additional details and impacted files
@@           Coverage Diff           @@
##            main    #506     +/-   ##
=======================================
+ Coverage   98.6%   98.9%   +0.2%     
=======================================
  Files         44      44             
  Lines       4794    4794             
=======================================
+ Hits        4729    4743     +14     
+ Misses        65      51     -14     
Files Coverage Δ
ixmp/backend/__init__.py 100.0% <ø> (ø)
ixmp/core/timeseries.py 98.7% <ø> (ø)
ixmp/report/operator.py 99.0% <ø> (ø)

... and 5 files with indirect coverage changes

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.

LGTM :)

@glatterf42
Copy link
Member

Rebased after dependabot update to main: I suppose this test failure is flaky. Should we include a corresponding marker?

@glatterf42 glatterf42 merged commit b7c264a into main Jan 11, 2024
21 checks passed
@glatterf42 glatterf42 deleted the fix/sphinx-nitpick branch January 11, 2024 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation, tutorials, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants