Skip to content

Doc: Change config to expand toc object entries#125754

Closed
willingc wants to merge 2 commits into
python:mainfrom
willingc:expand-contents
Closed

Doc: Change config to expand toc object entries#125754
willingc wants to merge 2 commits into
python:mainfrom
willingc:expand-contents

Conversation

@willingc
Copy link
Copy Markdown
Contributor

@willingc willingc commented Oct 20, 2024 •
edited by github-actions Bot
Loading

Expand the toctree entries for the sidebar. Pages with lots of methods/functions would benefit from easier click-through navigation.

Prompted to experiment due to the Discourse discussion: https://discuss.python.org/t/summary-tables-as-an-api-overview/68474

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

@willingc
Copy link
Copy Markdown
Contributor Author

willingc commented Oct 20, 2024

@hugovk Do you remember why we have this set to False currently?

@willingc willingc added the docs Documentation in the Doc dir label Oct 20, 2024
@hugovk
Copy link
Copy Markdown
Member

hugovk commented Oct 20, 2024

Added in #114318 because some of the menus were far too long and crowded to be useful.

See https://cpython-previews--125754.org.readthedocs.build/en/125754/library/sqlite3.html#module-sqlite3 from this PR.

@willingc
Copy link
Copy Markdown
Contributor Author

willingc commented Oct 20, 2024 •
edited
Loading

I think it may be time to revisit this setting and look at some CSS or custom solution. I really wish we had the righthand sidebar like the science world typically uses.

Added this to the Doc Community agenda for November.

@hugovk
Copy link
Copy Markdown
Member

hugovk commented Oct 20, 2024

I think it may be time to revisit this setting and look at some CSS or custom solution. I really wish we had the righthand sidebar like the science world typically uses.

Funny you should mention that, I just suggested the PyData them over here: https://discuss.python.org/t/summary-tables-as-an-api-overview/68474/17 :)

@AA-Turner AA-Turner mentioned this pull request Oct 20, 2024
Merged
@willingc
Copy link
Copy Markdown
Contributor Author

willingc commented Oct 20, 2024

Closing this PR since #125757 is a more elegant solution. Thanks @AA-Turner

@willingc willingc closed this Oct 20, 2024
@willingc willingc deleted the expand-contents branch October 20, 2024 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

awaiting core review 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.

2 participants

@willingc @hugovk