Skip to content

Show errors and warnings in doc CI after build. #23868

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

Merged
merged 1 commit into from
Sep 12, 2022

Conversation

oscargus
Copy link
Member

@oscargus oscargus commented Sep 11, 2022

PR Summary

Adds a separate step that summarized the warnings and errors during documentation build.

Adds a step which checks for deprecation warnings in examples and tutorials.

I'm quite sure that there is an issue for that which I cannot find, but ideally this should be fed back to GitHub as a comment so it will still not be closed.

Anyway, this should help a bit as it is easier than scrolling back in the very long log (and some messages may have disappeared...).

Helps with #23866

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@oscargus oscargus force-pushed the sphinxerrorwarnings branch 4 times, most recently from 9d17527 to eff2456 Compare September 11, 2022 12:56
@oscargus
Copy link
Member Author

In addition, two examples are edited to not use "DeprecationWarning" and reflect the current status.

@tacaswell tacaswell added this to the v3.7.0 milestone Sep 11, 2022
@tacaswell
Copy link
Member

🎉 This is a very big win at a very small cost!

@oscargus
Copy link
Member Author

It should be quite easy to get those results out and comment in the PR as well. Given that one knows how to do the GitHub-part...

@QuLogic QuLogic merged commit 97b42f8 into matplotlib:main Sep 12, 2022
@oscargus oscargus deleted the sphinxerrorwarnings branch September 13, 2022 07:54
@timhoffm
Copy link
Member

Great! 🚀 This addresses my issue #22176.

Posting a comment is easy https://stackoverflow.com/a/64126737.

@rcomer
Copy link
Member

rcomer commented Dec 4, 2022

@meeseeksdev backport to v3.6.2-doc

@rcomer
Copy link
Member

rcomer commented Dec 4, 2022

@meeseeksdev backport to v3.6.x

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 4, 2022
rcomer added a commit that referenced this pull request Dec 4, 2022
…868-on-v3.6.2-doc

Backport PR #23868 on branch v3.6.2-doc (Show errors and warnings in doc CI after build.)
tacaswell added a commit that referenced this pull request Dec 4, 2022
…868-on-v3.6.x

Backport PR #23868 on branch v3.6.x (Show errors and warnings in doc CI after build.)
@QuLogic QuLogic modified the milestones: v3.7.0, v3.6-doc Dec 6, 2022
@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants