Task #3275
closed
Make docs build with sphinx 1.6.6
Status:
CLOSED - CURRENTRELEASE
Description
We currently get a lot of errors when building our docs with sphinx 1.6.6. We need to figure out if this is a bug in sphinx or there is a new config we need to change.
Bisecting Sphinx shows that our docs start failing to build with the Sphinx commit 90352cf that in turn supposed to fix the Sphinx regression 3919 i.e correct the behavior when treating warnings and nitpicking as errors; we'd better fix our docs or disable the warning as an error feature (as an alternative to pinning the Sphinx version)
I'm +1 to fixing the docs and not disabling the warnings as errors feature.
- Status changed from NEW to ASSIGNED
- Sprint/Milestone set to 53
milan wrote:
Bisecting Sphinx shows that our docs start failing to build with the Sphinx commit 90352cf that in turn supposed to fix the Sphinx regression 3919 i.e correct the behavior when treating warnings and nitpicking as errors; we'd better fix our docs or disable the warning as an error feature (as an alternative to pinning the Sphinx version)
Oh, and the credit goes to @goosemania :)
- Status changed from ASSIGNED to MODIFIED
- % Done changed from 0 to 100
- Sprint/Milestone deleted (
53)
- Sprint/Milestone set to 3.0.0
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Also available in: Atom
PDF
.
Fix doc build (warning) errors
Sphinx in 1.6.6 fixed a regression that would allow doc build warnings to pass unnoticed[1]. Thus having updated Sphinx would have broken one's Pulp docs build.
This patch addresses the doc build warnings as well as fixes a broken link here and there.
[1] https://github.com/sphinx-doc/sphinx/issues/3919
closes: #3275 https://pulp.plan.io/issues/3275