Ouranosinc / xclim / 8929138774

92%

Build Type

push

github

Committed by web-flow

Commit Message

Use Furo documentation theme (#1731)

### What kind of change does this PR introduce?

* Replaces the `sphinx-rtd-theme` for the `furo` documentation theme
* Adapts the `conf.py` to make use of specific variables for `furo`
* `pygments` themes and CSS overrides have been added to ensure adequate
contrast of documentation elements in both "dark" and "light" modes
* Adds alternate logos for the "dark" theme
* Updates the docstrings for `xclim/data/__init__.py`,
`xclim/core/locales.py`, `xclim/core/formatting.py`, and others
* Synchronizes tooling dependency versions (ruff, black, yamllint)
* `generate_indicator_docstring` has been adjusted to ensure that
information blocks (e.g. `Parameters`, `Returns`) always have newlines
between them and that call signature attributes are indented four (4)
spaces instead of two (2)
* The `pygments`-affected code blocks in `extendxclim.ipynb` have been
modified to produce nicer outputs

### Does this PR introduce a breaking change?

Yes. 
- The theme has been completely replaced with `furo`, which gives us a
dark mode for free as well as better navigation scroll bars when viewing
pages in landscape mode.
- Indicator docstrings have been modified to ensure that `Parameters`
items conform strictly to `numpy`-docstring format (indentations of four
spaces for attributes, changed from two spaces).

Run Details

13 of 13 new or added lines in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

8827 of 9706 relevant lines covered (90.94%)

5.87 hits per line