Ouranosinc / xclim / 26121612934
92%

DEFAULT BRANCH: main
Ran
Jobs 6
Files 60
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 91.834%. Remained the same
26121612934

push

github

web-flow 
Fix Indicator documentation for Sphinx 9 (#2358)

<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [ ] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #xyz
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [x] CHANGELOG.rst has been updated (with summary of main changes)
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

### What kind of change does this PR introduce?
Turns out sphinx 9 became the one installed in the RTD env somewhere
between xclim 0.60 and 0.61. Sphinx 9 has completely rewritten the
`autodoc` module and our custom indicator documenter is not supported in
the new version.

Recall that an indicator is an instance of the `Indicator` class, so not
one of the objects `autodoc` knows how to document. We have a custom
sphinx extension that registers an `IndicatorDocumenter` which inherits
`FunctionDocumenter` and allows documenting indicators as if they were
functions.

The "legacy" method is still usable with a new option, which this PR
activates.

It looks like extending the new `autodoc` in a similar way is simply
impossible for the moment. There's an issue open on sphinx about this.
For the record : sphinx's doc has an example for custom documenters and
no where in it does it mentions that it's using a "legacy" mechanism and
there's no explanation on how to do this with the new version yet.


The changes to `autodoc_indicator.py` are mainly esthetic, remnants from
a few experiments trying to make it work before finding the solution.

7940 of 8646 relevant lines covered (91.83%)

6.27 hits per line

Jobs
ID Job ID Ran Files Coverage
1 run-3.12-ubuntu-latest- - 26121612934.1 60
88.71
 GitHub Action Run
2 run-3.13-macos-latest- - 26121612934.2 60
91.04
 GitHub Action Run
3 run-3.13-ubuntu-latest- - 26121612934.3 60
88.03
 GitHub Action Run
4 run-{{ matrix.python-version }}-conda - 26121612934.4 60
91.42
 GitHub Action Run
5 run-3.10-ubuntu-latest- - 26121612934.5 60
88.04
 GitHub Action Run
6 run-3.14-ubuntu-latest- - 26121612934.6 60
88.03
 GitHub Action Run
Source Files on build 26121612934