8000 DOC: fail the doc build on errors, but keep going to end by tacaswell · Pull Request #13657 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: fail the doc build on errors, but keep going to end #13657

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 14, 2019
Merged

DOC: fail the doc build on errors, but keep going to end #13657

merged 2 commits into from
Mar 14, 2019

Conversation

tacaswell
Copy link
Member

h/t to pandas and @TomAugspurger

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@tacaswell tacaswell added this to the v3.2.0 milestone Mar 12, 2019
@tacaswell tacaswell force-pushed the doc_finish_then_fail branch from 25a78b0 to 9ee3cb7 Compare March 12, 2019 01:57
anntzer
anntzer previously requested changes Mar 12, 2019
View reviewed changes
Copy link
Contributor
@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

this bumps the minimum supported sphinx version to 1.8 (which I'm happy with, but needs to be documented).
anyone can dismiss post handling.

@timhoffm
Copy link
Member

I took the liberty to push the updated sphinx requirements and --keep-going documentation. May be squashed.

@timhoffm timhoffm dismissed anntzer’s stale review March 12, 2019 23:02

Comment handled.

tacaswell
tacaswell commented Mar 14, 2019
View reviewed changes
Copy link
Member Author
@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

This will be in a released version ~1 year after 1.8 was released. This is a bit aggressive, but ok.

I also approve of @timhoffm 's changes, but can not formally do so due it being my PR.

Someone other than Tim or me should merge this.

@jklymak
Copy link
Member
jklymak commented Mar 14, 2019

This seems fine to me - if someone is building the docs with old sphinx, they can pretty easily figure out they can't call w/ this flag.

@jklymak jklymak merged commit 3c86054 into matplotlib:master Mar 14, 2019
@tacaswell tacaswell deleted the doc_finish_then_fail branch March 14, 2019 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

@timhoffm timhoffm timhoffm approved these changes

@anntzer anntzer anntzer left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@tacaswell @timhoffm @jklymak @anntzer
0