Ouranosinc / xclim / 5926637515

90%

main: 92%

push

github

Documentation adjustments (#1449)

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

* Moves apidoc-generated files into their own folder
* Moves example files into their own folder
* Adjusts docstrings for some classes
* Changes to `cli.py` now trigger `API` label
* Excludes Jupyter notebooks from pretty-format-json
* Added a helper module `_finder` in the notebooks so that the working
directory can always be found. Redundancies in place to prevent scripts
from failing if the helper is not found.

### Does this PR introduce a breaking change?

No*, but the documentation will look a tiny bit different.

### Other information:

See: https://github.com/pre-commit/identify/pull/401

Why did I add `_finder.py`? Because Jupyter Notebooks do not provide
`__file__`! See: https://stackoverflow.com/a/52119628/7322852

14 of 16 new or added lines in 3 files covered. (87.5%)

8262 of 9113 relevant lines covered (90.66%)

3.48 hits per line