Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 12 commits into from Dec 15, 2023
Merged

Conversation

Zeitsperre
Copy link
Contributor

@Zeitsperre Zeitsperre commented Dec 14, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • This PR does not seem to break the templates.
  • CHANGES.rst has been updated (with summary of main changes).
    • 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.

@github-actions github-actions bot added CI Modifications to autiomation utilities docs labels Dec 14, 2023
Copy link
Contributor

@juliettelavoie juliettelavoie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah! thanks !

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Zeitsperre
Copy link
Contributor Author

@aulemahal

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

@aulemahal
Copy link
Collaborator

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
Copy link
Collaborator

aulemahal commented Dec 15, 2023

@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
Copy link
Contributor Author

@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
Copy link
Collaborator

Oh I see! Thanks!

@Zeitsperre
Copy link
Contributor Author

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

Zeitsperre and others added 2 commits December 15, 2023 15:45
Co-authored-by: Pascal Bourgault <bourgault.pascal@ouranos.ca>
Copy link
Collaborator

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve this.

@Zeitsperre Zeitsperre merged commit fded6b9 into main Dec 15, 2023
18 checks passed
@Zeitsperre Zeitsperre deleted the fix-docs branch December 15, 2023 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Modifications to autiomation utilities docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants