DOC: Making the build fail if the doc build fails #24292
Conversation
|
Hello @datapythonista! Thanks for submitting the PR.
|
.travis.yml
Outdated
|
|
||
| # In allow_failures | ||
| - dist: trusty | ||
| env: | ||
| - JOB="3.6, doc" ENV_FILE="ci/deps/travis-36-doc.yaml" DOC=true |
There was a problem hiding this comment.
leave all of this
i am not convinced this build is actually reliable enough to change this
There was a problem hiding this comment.
You'll know better, I just thought that it'd be a good idea to make it break the build for a while, to see if it's actually reliable. Other than taking too long, does it fails with false positives often for any reason?
There was a problem hiding this comment.
let's make that an independent change.
There was a problem hiding this comment.
fair enough, reverted that part
There was a problem hiding this comment.
BTW, the travis build here is only failing when the sphinx build is completely failing, not when there is an error in the doc build. So that shouldn't happen too often.
There was a problem hiding this comment.
Actually, the doc build is failing on travis now. But I am wondering if this is because of "fatal: No such remote: origin".
In that case, we should either fix that to not try to push the docs the github repo on PRs, or revert this PR, as it will currently always fail on PRs.
Codecov Report
@@ Coverage Diff @@
## master #24292 +/- ##
==========================================
- Coverage 92.28% 92.22% -0.06%
==========================================
Files 162 162
Lines 51827 51824 -3
==========================================
- Hits 47827 47795 -32
- Misses 4000 4029 +29
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #24292 +/- ##
=======================================
Coverage 92.28% 92.28%
=======================================
Files 162 162
Lines 51827 51827
=======================================
Hits 47827 47827
Misses 4000 4000
Continue to review full report at Codecov.
|
|
thanks @datapythonista |
The doc build is failing silently if sphinx fails. This PR makes the CI red when something goes wrong building the docs.
CC: @jreback
It has been tested here: https://travis-ci.org/pandas-dev/pandas/jobs/468243202