[issue30380] Sphinx 1.6.1 raising new warnings in docs build
New submission from Brett Cannon: The Travis file uses `make venv` which does `python3 -m pip install --upgrade sphinx` which is pulling in Sphinx 1.6.1 which was released today (under Python 2.7 the pip call is direct instead of using `make venv`). The problem is that Sphinx 1.6.1 adds some new warnings that then is flagging the docs build as failing. To fix this we should probably stop calling `make venv` in .travis.yml and instead explicitly install Sphinx 1.5.6 for the docs build. Once Travis is green again a separate PR can be done to update `master` to build cleanly under Sphinx 1.6.1. ---------- assignee: docs@python components: Documentation messages: 293775 nosy: brett.cannon, docs@python priority: critical severity: normal status: open title: Sphinx 1.6.1 raising new warnings in docs build versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: Technically it's probably best to do `python3 -m pip install sphinx~=1.5.6` so bugfix releases are picked up. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Mariatta Wijaya <mariatta.wijaya@gmail.com>: ---------- pull_requests: +1701 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- pull_requests: +1702 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Serhiy Storchaka added the comment: PR 1613 tries to fix a warning by using explicit footnote numbering. ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Serhiy Storchaka added the comment: New changeset d97b7dc94b19063f0589d401bdc4aaadc7030762 by Serhiy Storchaka in branch 'master': bpo-30380: Fix Sphinx 1.6.1 warnings. (#1613) https://github.com/python/cpython/commit/d97b7dc94b19063f0589d401bdc4aaadc70... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- pull_requests: +1703 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- pull_requests: +1704 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Serhiy Storchaka <storchaka+cpython@gmail.com>: ---------- pull_requests: +1705 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: New changeset fca224f117d25bdfec1bf7160b67438c4fcf6dee by Brett Cannon (Mariatta) in branch 'master': bpo-30380: Pin the version of Sphinx used to build the documentation (GH-1612) https://github.com/python/cpython/commit/fca224f117d25bdfec1bf7160b67438c4fc... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- pull_requests: +1706 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- pull_requests: +1707 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Serhiy Storchaka added the comment: New changeset 8fc1ff51adb52c80f6bf78393413c72543bae3e1 by Serhiy Storchaka in branch '3.6': [3.6] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1614) https://github.com/python/cpython/commit/8fc1ff51adb52c80f6bf78393413c72543b... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- pull_requests: +1708 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: New changeset 5e2016dce92d66e6e1fb25e6ce39031d8c7d5412 by Brett Cannon in branch '3.6': bpo-30380: Pin the version of Sphinx used to build the docs (GH-1612) (GH-1617) https://github.com/python/cpython/commit/5e2016dce92d66e6e1fb25e6ce39031d8c7... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: New changeset 083f13e34c0b9f9ed4ed64fed3989d4af97843b3 by Brett Cannon (Serhiy Storchaka) in branch '3.5': [3.5] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (GH-1615) https://github.com/python/cpython/commit/083f13e34c0b9f9ed4ed64fed3989d4af97... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: New changeset 77606957e71ce477d2c5569718f0fc36f05c6f59 by Brett Cannon in branch '3.5': bpo-30380: Pin the version of Sphinx used to build the documentation (GH-1612) (GH-1618) https://github.com/python/cpython/commit/77606957e71ce477d2c5569718f0fc36f05... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: New changeset 97eb2a7d77011605e8fc49e754cd371ead4366bc by Brett Cannon in branch '2.7': [2.7] bpo-30380: Pin the version of Sphinx used to build the docs (GH-1612) (GH-1619) https://github.com/python/cpython/commit/97eb2a7d77011605e8fc49e754cd371ead4... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: All branches should be green again. Serhiy has a PR out to fix 2.7 for Sphinx 1.6.1, but it isn't passing yet so that branch is pinned to 1.5.6 until then. I will leave this issue open for Serhiy to close once his 2.7 PR is merged. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Serhiy Storchaka added the comment: New changeset b8b9f95f660d00ce9bd11bd9de429176858be3c5 by Serhiy Storchaka in branch '2.7': [2.7] bpo-30380: Fix Sphinx 1.6.1 warnings. (GH-1613) (#1616) https://github.com/python/cpython/commit/b8b9f95f660d00ce9bd11bd9de429176858... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Serhiy Storchaka added the comment: There was other warnings, mostly false positive, but there were also the real documentation bugs. Sphinx now converts quotes to Unicode variants at earlier stage (this is good thing, because converting them at late stage, in HTML, not always worked), and rules in susp-ignored.csv containing '"' no longer worked. Now warnings in 2.7 are fixed and Sphinx can be pinned to 1.6.1. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- pull_requests: +1833 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
Brett Cannon added the comment: All branches are now pinned to and working under Sphinx 1.6.1, so I'm closing this as fixed! ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue30380> _______________________________________
participants (3)
-
Brett Cannon -
Mariatta Wijaya
-
Serhiy Storchaka