This issue tracker has been migrated to GitHub ,
and is currently read-only.
For more information,
see the GitHub FAQs in the Python's Developer Guide.
Created on 2013年02月18日 19:50 by pitrou, last changed 2022年04月11日 14:57 by admin. This issue is now closed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| issue17227.patch | kushal.das, 2013年02月22日 05:47 | |||
| iss17227.patch | willingc, 2015年04月18日 22:49 | |||
| Messages (14) | |||
|---|---|---|---|
| msg182338 - (view) | Author: Antoine Pitrou (pitrou) * (Python committer) | Date: 2013年02月18日 19:50 | |
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 |
|||
| msg182477 - (view) | Author: Chris Jerdonek (chris.jerdonek) * (Python committer) | Date: 2013年02月20日 07:40 | |
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). |
|||
| msg182478 - (view) | Author: Antoine Pitrou (pitrou) * (Python committer) | Date: 2013年02月20日 07:47 | |
Georg, do you know how to fix this? |
|||
| msg182480 - (view) | Author: Chris Jerdonek (chris.jerdonek) * (Python committer) | Date: 2013年02月20日 07:56 | |
> 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. |
|||
| msg182634 - (view) | Author: Kushal Das (kushal.das) * (Python committer) | Date: 2013年02月22日 05:47 | |
Adding a patch to fix this issue. |
|||
| msg182641 - (view) | Author: Chris Jerdonek (chris.jerdonek) * (Python committer) | Date: 2013年02月22日 05:55 | |
> 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. |
|||
| msg182644 - (view) | Author: Kushal Das (kushal.das) * (Python committer) | Date: 2013年02月22日 06:07 | |
>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. |
|||
| msg182653 - (view) | Author: Kushal Das (kushal.das) * (Python committer) | Date: 2013年02月22日 07:12 | |
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. |
|||
| msg217152 - (view) | Author: Terry J. Reedy (terry.reedy) * (Python committer) | Date: 2014年04月25日 04:29 | |
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. |
|||
| msg217433 - (view) | Author: Antoine Pitrou (pitrou) * (Python committer) | Date: 2014年04月28日 22:26 | |
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? |
|||
| msg241463 - (view) | Author: Carol Willing (willingc) * (Python committer) | Date: 2015年04月18日 22:49 | |
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). |
|||
| msg241470 - (view) | Author: Berker Peksag (berker.peksag) * (Python committer) | Date: 2015年04月19日 01:16 | |
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". |
|||
| msg241526 - (view) | Author: Carol Willing (willingc) * (Python committer) | Date: 2015年04月19日 18:17 | |
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. |
|||
| msg271019 - (view) | Author: Brett Cannon (brett.cannon) * (Python committer) | Date: 2016年07月22日 19:51 | |
Moved to https://github.com/python/devguide/issues/11 |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022年04月11日 14:57:41 | admin | set | github: 61429 |
| 2016年07月22日 19:51:32 | brett.cannon | set | status: open -> closed nosy: + brett.cannon messages: + msg271019 resolution: out of date |
| 2015年04月19日 18:17:00 | willingc | set | messages: + msg241526 |
| 2015年04月19日 01:16:51 | berker.peksag | set | nosy:
+ berker.peksag messages: + msg241470 |
| 2015年04月18日 22:49:13 | willingc | set | files:
+ iss17227.patch nosy: + willingc messages: + msg241463 assignee: willingc stage: patch review |
| 2014年04月28日 22:26:49 | pitrou | set | messages: + msg217433 |
| 2014年04月25日 04:29:23 | terry.reedy | set | nosy:
+ terry.reedy messages: + msg217152 |
| 2013年02月22日 07:12:48 | kushal.das | set | messages: + msg182653 |
| 2013年02月22日 06:07:10 | kushal.das | set | messages: + msg182644 |
| 2013年02月22日 05:55:35 | chris.jerdonek | set | messages: + msg182641 |
| 2013年02月22日 05:47:00 | kushal.das | set | files:
+ issue17227.patch nosy: + kushal.das messages: + msg182634 keywords: + patch |
| 2013年02月20日 07:56:21 | chris.jerdonek | set | messages: + msg182480 |
| 2013年02月20日 07:47:45 | pitrou | set | nosy:
+ georg.brandl messages: + msg182478 |
| 2013年02月20日 07:40:04 | chris.jerdonek | set | messages: + msg182477 |
| 2013年02月18日 23:09:51 | chris.jerdonek | set | nosy:
+ chris.jerdonek |
| 2013年02月18日 19:50:02 | pitrou | create | |