Task #3275: Make docs build with sphinx 1.6.6 - Pulp

Send by e-mail

Task #3275

Make docs build with sphinx 1.6.6

Added by dkliban@redhat.com over 2 years ago. Updated 7 months ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

milan

Category:

Sprint/Milestone:

3.0.0

Start date:

Due date:

% Done:

100%

Estimated time:

Platform Release:

Groomed:

Sprint Candidate:

Tags:

Sprint:

Sprint 31

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.

Associated revisions

Revision e01f0498 View on GitHub
Added by milan over 2 years ago

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

Revision e01f0498 View on GitHub
Added by milan over 2 years ago

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

History

#1 Updated by milan over 2 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)

#2 Updated by bmbouter over 2 years ago

I'm +1 to fixing the docs and not disabling the warnings as errors feature.

#3 Updated by milan over 2 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 :)