Do not fail because of Linkcheck, add ignored links

Ouranosinc / xscen

A climate change scenario-building analysis framework.

https://xscen.readthedocs.io/

Apache License 2.0

15 stars 2 forks source link

Do not fail because of Linkcheck, add ignored links #304

Closed Zeitsperre closed 9 months ago

Zeitsperre commented 9 months ago

Pull Request Checklist:

[ ] This PR addresses an already opened issue (for bug fixes / features)
- This PR fixes #xyz
[x] (If applicable) Documentation has been added / updated (for bug fixes / features).
[ ] (If applicable) Tests have been added.
[x] This PR does not seem to break the templates.
[x] CHANGES.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?

Added some links to ignore
Configured ReadTheDocs to not fail build if Linkcheck step fails
Moved notebooks into an "Examples" section

Does this PR introduce a breaking change?

No.

review-notebook-app[bot] commented 9 months ago

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

Zeitsperre commented 9 months ago

@aulemahal

It looks like your latest notebook is failing. Shall I leave the fix up to you here?

aulemahal commented 9 months ago

Woups, this notebook is not supposed to run. I'll deactivate it.

I kept it in the repo to show how the results were obtained, and to make it easy to manually update the timeseries, periodically. But it makes reference to data inside ouranos and this link for NOAA's dataset changes each month.

aulemahal commented 9 months ago

@Zeitsperre I added the "NO_COLOR" env var to the admin panel of RTD, should make the online output easier to read!

Otherwise, the only warning I can find in the last build is coming from Clisops... Or I missed something else ?

Zeitsperre commented 9 months ago

@aulemahal

The final warning in the docs build is coming from the fact that the notebook is not explicitly ignored. (UserWarnings and other Python-specific warnings don't count). I'm on it.

aulemahal commented 9 months ago

Oh I see! Thanks!

Zeitsperre commented 9 months ago

Errors are finally all addressed. I've restructured the notebooks for flow; If this isn't what we want, I can revert the changes.