Docs: align homepage reading order with chapter navigation · Issue #157525 · python/cpython · GitHub
Skip to content

Docs: align homepage reading order with chapter navigation #157525

Description

@m-aciek

Documentation

The documentation homepage presents sections in two columns, but its markup groups entries by column. Consequently, the order when the layout collapses to one column differs from the order obtained by reading the desktop layout row by row.

The root toctree in Doc/contents.rst also uses a different chapter order, making Previous/Next navigation inconsistent with the homepage.

Order of chapters, standard viewports Image
Order of chapters, narrow viewports Image
Next topic after last tutorial topic is Python setup and usage (installing/index.rst), which is nowhere near in chapters list Image

We should establish a consistent sequence across:

  • The desktop homepage, read row by row.
  • The single-column homepage on smaller screens.
  • Previous/Next chapter navigation.

The proposed change is to use a wrapping flex layout in Doc/tools/templates/indexcontent.html, arrange the entries in the intended reading order, and update Doc/contents.rst to match.

Linked PRs

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions