Skip to content
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

Doc: Show object descriptions in the table of contents #125757

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Doc: Show object descriptions in the table of contents #125757

merged 3 commits into from
Oct 22, 2024

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Oct 20, 2024 •
edited by github-actions bot
Loading

Alternative to #125754, for discussion.

A

📚 Documentation preview 📚: https://cpython-previews--125757.org.readthedocs.build/

@AA-Turner AA-Turner added skip issue skip news docs Documentation in the Doc dir labels Oct 20, 2024
@willingc
Copy link
Contributor

@AA-Turner I love it! Thank you for your Sphinx expertise. I'm going to close #125754 since this exceeds my expectations. 🎉

@willingc willingc mentioned this pull request Oct 20, 2024
Closed
@AA-Turner AA-Turner marked this pull request as ready for review October 20, 2024 22:59
@willingc
Copy link
Contributor

I've been going through this page by page and it's a definite enhancement on most pages. I would recommend checking out the os module and built-in types to see if offering the ability to collapse a level would make sense, or if there is another way, short of a righthand sidebar that would shorten those pages. It may be that some of those pages could be split.

@AA-Turner
Copy link
Member Author

I'll merge this for now as it's had some support here and on Discourse, but if it turns out to be too disruptive we can revert quite easily.

A

@AA-Turner AA-Turner added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Oct 22, 2024
@AA-Turner AA-Turner merged commit 91ddde4 into python:main Oct 22, 2024
29 checks passed
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@AA-Turner AA-Turner deleted the docs/objdesc-toc branch October 22, 2024 13:07
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 22, 2024
@AA-Turner @miss-islington
Doc: Show object descriptions in the table of contents (pythonGH-125757)
6c7af3f 
(cherry picked from commit 91ddde4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Oct 22, 2024

GH-125840 is a backport of this pull request to the 3.13 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 22, 2024
@AA-Turner @miss-islington
Doc: Show object descriptions in the table of contents (pythonGH-125757)
97ef559 
(cherry picked from commit 91ddde4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 22, 2024
@bedevere-app
Copy link

bedevere-app bot commented Oct 22, 2024

GH-125841 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Oct 22, 2024
AA-Turner added a commit that referenced this pull request Oct 22, 2024
@miss-islington @AA-Turner
[3.13] Doc: Show object descriptions in the table of contents (GH-125757
22ae72b 
) (#125840)

(cherry picked from commit 91ddde4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this pull request Oct 22, 2024
@miss-islington @AA-Turner
[3.12] Doc: Show object descriptions in the table of contents (GH-125757
98a0b36 
) (#125841)

(cherry picked from commit 91ddde4)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
hugovk added a commit to hugovk/cpython that referenced this pull request Jan 2, 2025
@hugovk
Revert "Doc: Show object descriptions in the table of contents (pytho…
e2fad16 
…n#125757)"

This reverts commit 91ddde4.
@hugovk hugovk mentioned this pull request Jan 2, 2025
Merged
@hugovk
Copy link
Member

hugovk commented Jan 2, 2025

I'll merge this for now as it's had some support here and on Discourse, but if it turns out to be too disruptive we can revert quite easily.

A

Unfortunately this has proved a bit too disruptive, I've opened #128406 to revert.

AA-Turner pushed a commit that referenced this pull request Jan 2, 2025
@hugovk
Revert "Doc: Show object descriptions in the table of contents (#125757…
c9d2bc6 
…)" (#128406)
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 2, 2025
@hugovk @miss-islington
Revert "Doc: Show object descriptions in the table of contents (pytho…
f23ebfd 
…nGH-125757)" (pythonGH-128406)

(cherry picked from commit c9d2bc6)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 2, 2025
@hugovk @miss-islington
Revert "Doc: Show object descriptions in the table of contents (pytho…
daf15bc 
…nGH-125757)" (pythonGH-128406)

(cherry picked from commit c9d2bc6)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
AA-Turner pushed a commit that referenced this pull request Jan 2, 2025
@miss-islington @hugovk
[3.13] Revert "Doc: Show object descriptions in the table of contents (…
cc5b03f 
…GH-125757)" (GH-128406) (#128413)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
AA-Turner pushed a commit that referenced this pull request Jan 2, 2025
@miss-islington @hugovk
[3.12] Revert "Doc: Show object descriptions in the table of contents (…
52c08ed 
…GH-125757)" (GH-128406) (#128414)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 2025
@hugovk @srinivasreddy
Revert "Doc: Show object descriptions in the table of contents (pytho…
02f3505 
…n#125757)" (python#128406)
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
@AA-Turner @ebonnal
Doc: Show object descriptions in the table of contents (python#125757)
dd00e5d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willingc willingc willingc approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@AA-Turner @willingc @hugovk