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.

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

Doc: Change config to expand toc object entries #125754

Closed
wants to merge 2 commits into from

Conversation

willingc
Copy link
Contributor

@willingc willingc commented Oct 20, 2024

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
Contributor Author

@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
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
Contributor Author

willingc 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.

Added this to the Doc Community agenda for November.

@hugovk
Copy link
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 :)

@willingc
Copy link
Contributor Author

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants