classification
Title: Automatically tabulate module contents in the docs
Type: enhancement Stage:
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7, Python 3.6, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: alexchandel, docs@python, mdk
Priority: normal Keywords:

Created on 2020-01-16 22:05 by alexchandel, last changed 2020-01-17 08:13 by xtreak.

Messages (1)
msg360148 - (view) Author: alex c (alexchandel) * Date: 2020-01-16 22:05
By default, the docs.python.org page for a module does not list or tabulate the contents of that module. This makes it difficult to browse a module's functions or get a bird's-eye view.

For example, the logging module (https://docs.python.org/3/library/logging.html) has almost 70 functions, methods, and attributes. But it's impossible to scan them without scrolling the entire length of the entry (~18 pages of US letter). Compare to the browsability of itertools (https://docs.python.org/3/library/itertools.html), which manually tabulates its functions in the first section.

docs.python.org should automatically generate a TOC of the module's contents (classes, functions, etc) in the navigation sidebar, below the existing sidebar sections (perhaps in a collapsible section). Rust's documentation does this (example: https://doc.rust-lang.org/std/time/struct.Duration.html), and doc.rust-lang.org also effectively allows the entire page to function as a TOC by providing a "collapse page" button.
History
Date User Action Args
2020-01-17 08:13:58xtreaksetnosy: + mdk
2020-01-16 22:05:46alexchandelcreate