[issue27202] make doctest fails on 2.7 release notes
New submission from Jelle Zijlstra: Running `make doctest` in the Doc/ repository of master fails on the 2.7 release notes. This patch excludes these files from `make doctest`, because it doesn't seem worth it to try to get these running in Python 3. ---------- assignee: docs@python components: Documentation files: no27doctests.patch keywords: patch messages: 267190 nosy: Jelle Zijlstra, docs@python priority: normal severity: normal status: open title: make doctest fails on 2.7 release notes versions: Python 3.6 Added file: http://bugs.python.org/file43170/no27doctests.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Martin Panter added the comment: What failures are seeing, and what version of Sphinx are you using? Perhaps this is related to Issue 26638? ---------- nosy: +martin.panter _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Changes by Martin Panter <vadmium+py@gmail.com>: ---------- Removed message: http://bugs.python.org/msg267213 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Martin Panter added the comment: Ignore my message; I was thinking of something different :) I presume you are running something like the following, which seems to smoke-test the examples in the documentation: make -C Doc doctest ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Jelle Zijlstra added the comment: Yes, I've been attempting to get that make to fully succeed. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Martin Panter added the comment: Since I stuck my neck out, I will say that this seems reasonable to me. We could probably still run doctest in the actual 2.7 branch to detect any errors there. ---------- stage: -> patch review versions: +Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Roundup Robot added the comment: New changeset 70af472451cb by Senthil Kumaran in branch '3.5': issue27202 - Exclude 2.x release notes from python3 make doctests. https://hg.python.org/cpython/rev/70af472451cb New changeset 2bb806539ca6 by Senthil Kumaran in branch 'default': [merge from 3.5] - issue27202 - Exclude 2.x release notes from python3 make doctests. https://hg.python.org/cpython/rev/2bb806539ca6 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Senthil Kumaran added the comment: Thanks for your contribution, Jelle. ---------- nosy: +orsenthil resolution: -> fixed stage: patch review -> resolved status: open -> closed type: -> behavior _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Berker Peksag added the comment: Perhaps it would be better to exclude all files in Doc/whatsnew. ---------- nosy: +berker.peksag _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Berker Peksag added the comment: By the way, after this I'm getting the following warnings: /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.7' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.6' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.5' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.4' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.3' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.2' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.1' /Users/berkerpeksag/projects/cpython/Doc/whatsnew/index.rst:11: WARNING: toctree contains reference to nonexisting document 'whatsnew/2.0' ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Jelle Zijlstra added the comment: Yes, I realized this patch is wrong: it excludes the 2.7 release notes from all make steps, not just `make doctest`. The attached patch reverts the conf.py change and instead uses directives to skip most doctests in the 2.7 release notes. The other 2.x release notes have no failing doctests. ---------- resolution: fixed -> status: closed -> open _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Changes by Jelle Zijlstra <jelle.zijlstra@gmail.com>: Added file: http://bugs.python.org/file43226/issue27202-revised.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Roundup Robot added the comment: New changeset 378c1d09b256 by Senthil Kumaran in branch '3.5': issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6) https://hg.python.org/cpython/rev/378c1d09b256 New changeset 31573473a50e by Senthil Kumaran in branch 'default': [merge from 3.5] - issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6) https://hg.python.org/cpython/rev/31573473a50e ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
Senthil Kumaran added the comment: Addressed the problem with the previous commit. ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue27202> _______________________________________
participants (5)
-
Berker Peksag -
Jelle Zijlstra
-
Martin Panter
-
Roundup Robot
-
Senthil Kumaran