Skip to content

DOC: Make sphinx fail the build when --warnings-are-errors is set #24523

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
Dec 31, 2018
Merged

DOC: Make sphinx fail the build when --warnings-are-errors is set #24523

merged 1 commit into from
Dec 31, 2018

Conversation

datapythonista
Copy link
Member

xref #22743

We already had an option --warnings-are-errors in doc/make.py, but it was making the doc build cancel after the first warning was found, generating a Python exception. Changed to finish the build, and not raise any error, but exit with 1.

Also, when building a single document, ignore the broken reference warnings (they are broken because we don't build the referenced documents).

@codecov
Copy link

codecov bot commented Dec 31, 2018

Codecov Report

Merging #24523 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24523   +/-   ##
=======================================
  Coverage   31.88%   31.88%           
=======================================
  Files         166      166           
  Lines       52434    52434           
=======================================
  Hits        16718    16718           
  Misses      35716    35716
Flag Coverage Δ
#multiple 30.28% <ø> (ø) ⬆️
#single 31.88% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bf9d41c...d66397a. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Dec 31, 2018

Codecov Report

Merging #24523 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24523   +/-   ##
=======================================
  Coverage   31.88%   31.88%           
=======================================
  Files         166      166           
  Lines       52434    52434           
=======================================
  Hits        16718    16718           
  Misses      35716    35716
Flag Coverage Δ
#multiple 30.28% <ø> (ø) ⬆️
#single 31.88% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bf9d41c...d66397a. Read the comment docs.

@jreback jreback added this to the 0.24.0 milestone Dec 31, 2018
@jreback jreback merged commit dc0ba05 into pandas-dev:master Dec 31, 2018
@jreback
Copy link
Contributor

jreback commented Dec 31, 2018

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants