When I open a documentation page there is a navigation pane on the left side with a table of contents. This is useful and often provides a good overview of the module (or whatever the page is documenting).
What I find missing is a list of functions provided by the module or class.
I will use pathlib as I have in other posts for my example. Pathlib provides good topics such as “concrete paths” or “Pure Paths” and also has general topics such as “renaming and deleting” or “permissions and ownership”. This is great as an overview, but most of the time I would really like to see a list of functions provide, or methods of the class. For pathlib I find that more than 90% of the time I just go to “comparison to os and os.path” because that has a list of functions.
I realize that the space in the sidebar is limited, and given the current non-collapsible implementation of it that adding a list of all the functions, classes, and methods could make it very long. I think even know having sub-lists in the sidebar be collapsible would be nice.
My goal is just to help make the documentation, which is good, even easier to use. I hope others will join in the discussion.