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

Fix doc build warnings #1357

Merged
merged 2 commits into from May 15, 2018

Conversation

Projects
None yet
3 participants
@jmbowman
Contributor

jmbowman commented May 14, 2018

Fixed all the current warnings from documentation builds, and configured tox to fail doc builds if any new warnings are introduced. The autosectionlabel extension had to be disabled because it caused "duplicate label" warnings in CHANGES.rst where the same subsections are used in a few different releases. Only 2-3 of the cross-references seem to have been depending on it anyway, fixed here by adding explicit section labels.

There was one link that no longer seems to correspond to any section in the docs; I just removed that one, let me know if there's something it should actually point to instead.

@pganssle

This comment has been minimized.

Member

pganssle commented May 14, 2018

This is ready to merge when the tests pass.

jmbowman and others added some commits May 14, 2018

@pganssle pganssle force-pushed the jmbowman:jmbowman/fix_doc_warnings branch from 331e950 to 78e887f May 14, 2018

@jaraco

jaraco approved these changes May 14, 2018

@pganssle pganssle merged commit 26b75f5 into pypa:master May 15, 2018

4 checks passed

codecov/patch Coverage not affected when comparing c70cc12...78e887f
Details
codecov/project 81.44% remains the same compared to c70cc12
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment