FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Check for errors/warnings on failed doc-builds by oscargus · Pull Request #24598 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Check for errors/warnings on failed doc-builds - #24598

Merged
timhoffm merged 1 commit into
matplotlib:mainfrom
oscargus:docbuilderrors
Dec 4, 2022
ConversationCommits (1)ChecksFiles changed
Merged

Check for errors/warnings on failed doc-builds#24598
timhoffm merged 1 commit into
matplotlib:mainfrom
oscargus:docbuilderrors

Conversation

oscargus commented Dec 3, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

PR Summary

I'm quite sure that this helps with #22176 (comment)

Still not good enough to solve the whole issue, but at least useable now...

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

oscargus commented Dec 3, 2022

Copy link
Copy Markdown
Member Author

This works now:

#!/bin/bash -eo pipefail
(grep "WARNING\|ERROR" /tmp/sphinxerrorswarnings.log ||
 echo "No errors or warnings")

WARNING: [autosummary] failed to import matplotlib.artist.Artist.get_foogure.
/home/circleci/project/doc/api/artist_api.rst:114: WARNING: autosummary: failed to import Artist.get_foogure.
CircleCI received exit code 0

oscargus added the Documentation: build building the docs label Dec 3, 2022
oscargus added this to the v3.6-doc milestone Dec 3, 2022
timhoffm merged commit 8a7a53a into matplotlib:main Dec 4, 2022

lumberbot-app Bot commented Dec 4, 2022

Copy link
Copy Markdown

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.6.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 8a7a53aa9cf2d0c70186b40bde5555264b3845c4
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #24598: Check for errors/warnings on failed doc-builds'
  1. Push to a named branch:
git push YOURFORK v3.6.x:auto-backport-of-pr-24598-on-v3.6.x
  1. Create a PR against branch v3.6.x, I would have named this PR:

"Backport PR #24598 on branch v3.6.x (Check for errors/warnings on failed doc-builds)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

lumberbot-app Bot commented Dec 4, 2022

Copy link
Copy Markdown

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.6.2-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 8a7a53aa9cf2d0c70186b40bde5555264b3845c4
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #24598: Check for errors/warnings on failed doc-builds'
  1. Push to a named branch:
git push YOURFORK v3.6.2-doc:auto-backport-of-pr-24598-on-v3.6.2-doc
  1. Create a PR against branch v3.6.2-doc, I would have named this PR:

"Backport PR #24598 on branch v3.6.2-doc (Check for errors/warnings on failed doc-builds)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

rcomer commented Dec 4, 2022

Copy link
Copy Markdown
Member

I think the conflict is because #23868 was not backported. I just triggered that.

rcomer commented Dec 4, 2022

Copy link
Copy Markdown
Member

@meeseeksdev backport to v3.6.2-doc

meeseeksmachine mentioned this pull request Dec 4, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 4, 2022
Backport PR matplotlib#24598: Check for errors/warnings on failed doc…
79cc808 
…-builds

rcomer commented Dec 4, 2022

Copy link
Copy Markdown
Member

Still needs backport to v3.6.x after #24612 is merged. But currently CI is failing on all v3.6.x PRs.

rcomer mentioned this pull request Dec 4, 2022
Merged
tacaswell added a commit that referenced this pull request Dec 4, 2022
Merge pull request #24614 from meeseeksmachine/auto-backport-of-pr-24…
4a37fac 
…598-on-v3.6.2-doc

Backport PR #24598 on branch v3.6.2-doc (Check for errors/warnings on failed doc-builds)

tacaswell commented Dec 4, 2022

Copy link
Copy Markdown
Member

@meeseeksdev backport to v3.6.x

meeseeksmachine mentioned this pull request Dec 4, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 4, 2022
Backport PR matplotlib#24598: Check for errors/warnings on failed doc…
66dde7f 
…-builds
oscargus deleted the docbuilderrors branch December 4, 2022 16:29
rcomer added a commit that referenced this pull request Dec 4, 2022
Merge pull request #24615 from meeseeksmachine/auto-backport-of-pr-24…
41075fa 
…598-on-v3.6.x

Backport PR #24598 on branch v3.6.x (Check for errors/warnings on failed doc-builds)
ksunden mentioned this pull request Feb 20, 2023
Merged
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

tacaswell tacaswell approved these changes
timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation: build building the docs

Projects

None yet

Milestone

v3.6-doc

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL