Revert "Doc: Show object descriptions in the table of contents (#125757)"#128406
Conversation
AA-Turner
left a comment
There was a problem hiding this comment.
Sorry for not managing to get to this -- we would like to include objects descriptions in the 'local toc' (per-page) but not the 'global toc'.
A
|
Thanks @hugovk for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
…nGH-125757)" (pythonGH-128406) (cherry picked from commit c9d2bc6) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
GH-128413 is a backport of this pull request to the 3.13 branch. |
…nGH-125757)" (pythonGH-128406) (cherry picked from commit c9d2bc6) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
|
GH-128414 is a backport of this pull request to the 3.12 branch. |
…GH-125757)" (GH-128406) (#128413) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
…GH-125757)" (GH-128406) (#128414) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@AA-Turner I would also like to see object descriptions on pages for individual modules. Is anyone working on that, or did this just get abandoned? I really liked having all the functions/methods listed in the sidebar. It made it easy to quickly find something, especially if I didn't know the exact name of the thing I was looking for. Here are some examples that are definitely worse without all the objects listed: With object descriptions:
Without object descriptions: |
This reverts commit 91ddde4.
Revert PR #125757 from October.
Re: https://discuss.python.org/t/summary-tables-as-an-api-overview/68474/37, https://discuss.python.org/t/summary-tables-as-an-api-overview/68474/53 etc.
The changes are a bit too extensive, so let's revert so this can be reworked later.
Before:
After:
cc @AA-Turner @willingc @pfmoore
📚 Documentation preview 📚: https://cpython-previews--128406.org.readthedocs.build/