Task #3275
closed
Make docs build with sphinx 1.6.6
100%
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.
Updated by milan over 6 years ago
- Assignee set to milan
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)
Updated by bmbouter over 6 years ago
I'm +1 to fixing the docs and not disabling the warnings as errors feature.
Updated by milan over 6 years ago
- 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 :)
Added by milan over 6 years ago
Added by milan over 6 years ago
Revision e01f0498 | View on GitHub
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.
Updated by milan over 6 years ago
...just posted https://github.com/pulp/pulp/pull/3263
Updated by milan over 6 years ago
- Status changed from ASSIGNED to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulp|e01f0498fc9a2f1c270ad9b1577afb5f1ddda7bd.
Updated by bmbouter over 4 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
.
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