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.

classification
Title: remove numbers from 3-.. level entries in docs toc
Type: behavior Stage: needs patch
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7, Python 2.6
process
Status: closed Resolution: remind
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, ezio.melotti, georg.brandl, r.david.murray, techtonik, terry.reedy
Priority: normal Keywords:

Created on 2010-06-28 18:28 by techtonik, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (12)
msg108850 - (view) Author: anatoly techtonik (techtonik) Date: 2010-06-28 18:28
It seems that left side ToC menu will be more clear without numeric prefixes from chapter on 3-.. nesting levels. How about to remove them?

For example - the ToC menu now starting from root level:

15.6. logging — Logging facility for Python
    * 15.6.1. Logging tutorial
          o 15.6.1.1. Simple examples
          o 15.6.1.2. Loggers
          o 15.6.1.3. Handlers
          o 15.6.1.4. Formatters
          o 15.6.1.5. Configuring Logging
          o 15.6.1.6. Configuring Logging for a Library
    * 15.6.2. Logging Levels
    * 15.6.3. Useful Handlers
...

will look like:

15.6. logging — Logging facility for Python
    * 1. Logging tutorial
          o 1.1. Simple examples
          o 1.2. Loggers
          o 1.3. Handlers
          o 1.4. Formatters
          o 1.5. Configuring Logging
          o 1.6. Configuring Logging for a Library
    * 2. Logging Levels
    * 3. Useful Handlers
...
msg108886 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2010-06-29 01:58
-1
msg108891 - (view) Author: anatoly techtonik (techtonik) Date: 2010-06-29 04:09
> R. David Murray <rdmurray@bitdance.com> added the comment:
>
> -1

Why? Do you like wrapped menu entries three lines long?
msg108898 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-06-29 08:42
This should be taken to the Sphinx tracker, as the feature needs to be implemented first.
msg108899 - (view) Author: anatoly techtonik (techtonik) Date: 2010-06-29 10:32
http://bitbucket.org/birkenfeld/sphinx/issue/460/strip-section-numbers-from-toc-menu
msg108905 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2010-06-29 13:46
If the change is confined to the left menu bar only, I'd be happy to have the numbers go away entirely.  But only putting in partial numbers strikes me as an invitation to confusion.  If other people prefer your scheme that's fine with me.  Almost the only time I look at the left menu bar (except on the front page of docs) is when I want to find the 'show source' link.
msg108908 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-06-29 14:14
+1 for removing numbers.
msg108952 - (view) Author: anatoly techtonik (techtonik) Date: 2010-06-29 21:12
That just proves that side menu is not very useful. When I need to jump to a sibling paragraph I usually click the rightmost entry in top bar. It takes two clicks to get there and one page reload instead of one.

Perhaps the ToC menu could be expanded using JS and some keyboard shortcut for convenience.
msg108956 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2010-06-29 23:16
No, it just proves that I don't use the side menu.  I use google and the 'find' function of my browser :)
msg108961 - (view) Author: anatoly techtonik (techtonik) Date: 2010-06-30 03:40
PHP site have a very convenient feature that if you enter http://php.net/some_func - it automatically executes function lookup for you or shows corresponding doc page, i.e. http://php.net/sort
msg109202 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-07-04 01:46
'Invalid' because invalid for this tracker and moved to sphinx tracker (there is no option for 'wrong tracker').

On Windows help-format docs, there are no numbers on the left. There are in the chapter TOC in the chapter pages. I would have to see an alternative before I would say yes to changing that.

I do wish the page/section for each module had a section toc with links so I could see what subsections there are and jump without scrolling. I gather that would be a sphinx tracker issue too.
msg112440 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-08-02 09:30
(Rationale for this resolution: On #3143, it was used to remind us to change a setting in Doc/conf.py after the switch to a new version of Sphinx with the new feature.)
History
Date User Action Args
2022-04-11 14:57:02adminsetgithub: 53352
2010-08-02 09:30:44eric.araujosetresolution: not a bug -> remind
messages: + msg112440
2010-07-04 01:46:57terry.reedysetresolution: not a bug

messages: + msg109202
nosy: + terry.reedy
2010-06-30 03:40:35techtoniksetmessages: + msg108961
2010-06-29 23:16:12r.david.murraysetmessages: + msg108956
2010-06-29 21:12:59techtoniksetmessages: + msg108952
2010-06-29 14:14:11eric.araujosetnosy: + eric.araujo
messages: + msg108908
2010-06-29 13:46:53r.david.murraysetmessages: + msg108905
versions: + Python 3.1
2010-06-29 10:32:03techtoniksetmessages: + msg108899
2010-06-29 08:42:05georg.brandlsetstatus: open -> closed
nosy: + georg.brandl
messages: + msg108898

2010-06-29 04:09:48techtoniksetmessages: + msg108891
2010-06-29 01:58:36r.david.murraysetnosy: + r.david.murray
messages: + msg108886
2010-06-28 21:24:49ezio.melottisetnosy: + ezio.melotti

type: behavior
stage: needs patch
2010-06-28 18:28:22techtonikcreate