[issue17227] devguide: buggy heading numbers

[Brett Cannon]

Brett Cannon added the comment:

Moved to https://github.com/python/devguide/issues/11

--
nosy: +brett.cannon
resolution:  -> out of date
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Carol Willing]

Carol Willing added the comment:

Berker, Thanks for the patch review. I'm going to work with the folks at Sphinx 
project this week to see if the headings are fixed in a newer Sphinx version. 
If so, I will make the change here. If not, I will follow your recommendation 
to close and create an issue on the Sphinx issue tracker.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Carol Willing]

Carol Willing added the comment:

Correct Python Developer FAQ Section 28 to match the style of Section 27.

Section numbers should now flow correctly in Sphinx. A section contents is 
displayed at the top of the section page for the user's convenience (especially 
since the FAQ questions have long titles).

--
assignee:  - willingc
nosy: +willingc
stage:  - patch review
Added file: http://bugs.python.org/file39111/iss17227.patch

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Berker Peksag]

Berker Peksag added the comment:

Thanks! The patch doesn't address msg182641 and I think this is a Sphinx bug(or 
perhaps a feature request?). tocdepth should not change the heading numbers. I 
couldn't find any similar report on the Sphinx issue tracker. So I suggest 
opening an issue there and closing this one as third party.

--
nosy: +berker.peksag

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Antoine Pitrou]

Antoine Pitrou added the comment:

I agree with Chris, changing the tocdepth doesn't sound like the right 
solution. Is this a Sphinx bug? Georg, could you please take a look?

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Terry J. Reedy]

Terry J. Reedy added the comment:

The only change is that '25' is now '28'.

A possible solution, without changing Sphinx, is to reduce the headers to a 
couple of words and put the question under the header, possibly in italics.

*Q. How do I do this difficult thing?*

A. Do 2 pushups, sleep 3 hours, drink water, and do it.

I am not sure how this would affect the linked index at the top that appears 
before 28.1 Communications.

--
nosy: +terry.reedy

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Kushal Das]

Kushal Das added the comment:

Adding a patch to fix this issue.

--
keywords: +patch
nosy: +kushaldas
Added file: http://bugs.python.org/file29155/issue17227.patch

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Chris Jerdonek]

Chris Jerdonek added the comment:

 Adding a patch to fix this issue.

I had tried this, but doesn't this make the contents in the left side bar 
unwieldy (and perhaps also on the devguide index page) -- is that what we want? 
 I was under the assumption that the purpose of the tocdepth directive was to 
avoid that.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Kushal Das]

Kushal Das added the comment:

I had tried this, but doesn't this make the contents in the left side bar 
unwieldy (and perhaps also on the devguide index page) -- is that what we 
want?  I was under the assumption that the purpose of the tocdepth directive 
was to avoid that.

Yes, missed that issue. Trying to find any other solution if possible.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Kushal Das]

Kushal Das added the comment:

I found that http://docs.python.org/devguide/stdlibchanges.html also has left 
side bar text with full index just like my patch does. For FAQ the problem is 
title texts are kind of long so they look bad.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Chris Jerdonek]

Chris Jerdonek added the comment:

I noticed this before and wasn't able to fix it after trying a few things.  I 
wonder if this is a limitation or bug in Sphinx.  At the top, the FAQ page has--

:tocdepth: 2

Levels beyond 2 are getting numbered 25 (the number of the top level) instead 
of having their numbering suppressed (as I would expect it to).

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Antoine Pitrou]

Antoine Pitrou added the comment:

Georg, do you know how to fix this?

--
nosy: +georg.brandl

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Chris Jerdonek]

Chris Jerdonek added the comment:

 Levels beyond 2 are getting numbered 25 (the number of the top level) instead 
 of having their numbering suppressed (as I would expect it to).

Actually, what I meant to say is that I would expect the tocdepth to affect 
only the level of the table of contents that is displayed (which it does), but 
not suppress or otherwise affect the numbering of the sections in the actual 
text.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Antoine Pitrou]

New submission from Antoine Pitrou:

If you look e.g. here:
http://docs.python.org/devguide/faq.html#communications

you'll see that all questions are numbered 25, while the upper headings are 
numbered 25.1, 25.2, etc.

Other places in the devguide seem fine, e.g. 
http://docs.python.org/devguide/stdlibchanges.html

--
components: Devguide
messages: 182338
nosy: eric.araujo, ezio.melotti, ncoghlan, pitrou
priority: normal
severity: normal
status: open
title: devguide: buggy heading numbers
type: behavior

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17227] devguide: buggy heading numbers

[Chris Jerdonek]

Changes by Chris Jerdonek chris.jerdo...@gmail.com:


--
nosy: +chris.jerdonek

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue17227
___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com