iiasa / ixmp

The ix modeling platform for integrated and cross-cutting scenario analysis
https://docs.messageix.org/ixmp
Apache License 2.0
36 stars 110 forks source link

Fix Sphinx nitpicks fron message_ix docs #506

Closed khaeru closed 5 months ago

khaeru commented 6 months ago

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

PR checklist

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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](https://app.codecov.io/gh/iiasa/ixmp/pull/506?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa) | Coverage Δ | | |---|---|---| | [ixmp/backend/\_\_init\_\_.py](https://app.codecov.io/gh/iiasa/ixmp/pull/506?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa#diff-aXhtcC9iYWNrZW5kL19faW5pdF9fLnB5) | `100.0% <ø> (ø)` | | | [ixmp/core/timeseries.py](https://app.codecov.io/gh/iiasa/ixmp/pull/506?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa#diff-aXhtcC9jb3JlL3RpbWVzZXJpZXMucHk=) | `98.7% <ø> (ø)` | | | [ixmp/report/operator.py](https://app.codecov.io/gh/iiasa/ixmp/pull/506?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa#diff-aXhtcC9yZXBvcnQvb3BlcmF0b3IucHk=) | `99.0% <ø> (ø)` | | ... and [5 files with indirect coverage changes](https://app.codecov.io/gh/iiasa/ixmp/pull/506/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=iiasa)
glatterf42 commented 5 months ago

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