Repository navigation
make doctest fails on 2.7 release notes #71389
Description
| BPO | 27202 |
|---|---|
| Nosy | @orsenthil, @berkerpeksag, @vadmium, @JelleZijlstra |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2016-06-05.05:24:06.838>
created_at = <Date 2016-06-04.00:04:06.022>
labels = ['type-bug', 'docs']
title = 'make doctest fails on 2.7 release notes'
updated_at = <Date 2016-06-05.05:24:06.836>
user = 'https://github.com/JelleZijlstra'bugs.python.org fields:
activity = <Date 2016-06-05.05:24:06.836>
actor = 'orsenthil'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-06-05.05:24:06.838>
closer = 'orsenthil'
components = ['Documentation']
creation = <Date 2016-06-04.00:04:06.022>
creator = 'JelleZijlstra'
dependencies = []
files = ['43170', '43226']
hgrepos = []
issue_num = 27202
keywords = ['patch']
message_count = 11.0
messages = ['267190', '267214', '267216', '267220', '267370', '267371', '267372', '267374', '267376', '267385', '267386']
nosy_count = 6.0
nosy_names = ['orsenthil', 'docs@python', 'python-dev', 'berker.peksag', 'martin.panter', 'JelleZijlstra']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue27202'
versions = ['Python 3.5', 'Python 3.6']
Activity
JelleZijlstra commentedon Jun 4, 2016
Running
make doctestin the Doc/ repository of master fails on the 2.7 release notes. This patch excludes these files frommake doctest, because it doesn't seem worth it to try to get these running in Python 3.vadmium commentedon Jun 4, 2016
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
JelleZijlstra commentedon Jun 4, 2016
Yes, I've been attempting to get that make to fully succeed.
vadmium commentedon Jun 4, 2016
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.
python-dev commentedon Jun 5, 2016
New changeset 70af472451cb by Senthil Kumaran in branch '3.5':
bpo-27202 - 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] - bpo-27202 - Exclude 2.x release notes from python3 make doctests.
https://hg.python.org/cpython/rev/2bb806539ca6
orsenthil commentedon Jun 5, 2016
Thanks for your contribution, Jelle.
berkerpeksag commentedon Jun 5, 2016
Perhaps it would be better to exclude all files in Doc/whatsnew.
berkerpeksag commentedon Jun 5, 2016
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'
JelleZijlstra commentedon Jun 5, 2016
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.
python-dev commentedon Jun 5, 2016
New changeset 378c1d09b256 by Senthil Kumaran in branch '3.5':
bpo-27202 - 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] - bpo-27202 - Fix the mistake in changesets 70af472451cb (3.5) and 2bb806539ca6 (3.6)
https://hg.python.org/cpython/rev/31573473a50e
orsenthil commentedon Jun 5, 2016
Addressed the problem with the previous commit.