Restructuring the stdlib docs

And some more:

Some more recent discussion on this topic starts here (with suggestions and some identified problems): Diátaxis and Python documentation - #9 by adorilson

Considerations on the turtle docs: Improving the Turtle library - #10 by adorilson

Here we’ve discussed listing modules in alphabetical order.

Last days, I’ve analyzed the library/index page. So, besides the alphabetical order, I have two more suggestions:

  1. Moving the module categories to a new page, replacing all of them in library/index by a meta-category, maybe “Standard library modules“
  2. Reviewing every category. For instance, we can rearrange the Tk’s stuff, something like:
    • Graphical user interfaces

      • turtle — Turtle graphics

      • IDLE

      • Graphical User Interfaces with Tk

      Here, the modules are listed on top. After them comes everything that isn’t a module itself. Also, I ask myself if IDLE shouldn’t be in the Development Tools category.

2 Likes