Skip to content

Table of Content improvements #2045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Table of Content improvements #2045

wants to merge 1 commit into from
+31 −6

Conversation

srittau
Copy link
Collaborator

@srittau srittau commented Jul 16, 2025

  • Remove extra top levels from main ToC.
  • Don't include sub-chapters of the specification in the main ToC.
  • Reduce the ToC level by one on the guides index.

@srittau
Table of Content improvements
53c0526 
* Remove extra top levels from main ToC.
* Don't include sub-chapters of the specification in the main ToC.
* Reduce the ToC level by one on the guides index.
JelleZijlstra
JelleZijlstra reviewed Jul 16, 2025
View reviewed changes
docs/index.rst
@@ -27,7 +42,7 @@ Specification
=============

.. toctree::
:maxdepth: 2
:maxdepth: 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually find it nicer to keep multiple levels of TOC here so you don't have to click through.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below for the rationale.

@srittau
Copy link
Collaborator Author

srittau commented Jul 16, 2025 •
edited
Loading

Rationale:

  • This was always bothering as redundant and ugly looking. Disadvantage: We now have a duplication in the ToC sources.
  • The spec is a very specialized document, not suitable for the vast majority of Python users. I feel one extra click for those specialists is worth the clearer ToC for ordinary users. Edit: Especially since the spec has many chapters that will push more relevant info to the bottom of the page.
  • On the guides index, directly linking to sub-chapters of specific guides didn't seem worth it to me. Users will usually want to read a complete guide.

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

@JelleZijlstra JelleZijlstra JelleZijlstra left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@srittau @JelleZijlstra