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

TOC does now show automatic generated sub-sections #79

Closed
hagenw opened this issue Oct 21, 2022 · 2 comments
Closed

TOC does now show automatic generated sub-sections #79

hagenw opened this issue Oct 21, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@hagenw
Copy link
Member

hagenw commented Oct 21, 2022

image

I can reproduce this locally when upgrading to the latest sphinx version.
So i guess this is a new feature.

@hagenw
Copy link
Member Author

hagenw commented Oct 21, 2022

It was introduced in sphinx-doc/sphinx#6316 (sphinx 5.2.0), and after complains they also added a config setting to be able to disable it: nocontentsentry and toc_object_entries (sphinx 5.2.3).

I would propose for the short term to disable it.

For the long-term we could use it to generate better TOCs as I always wanted to add a way to include the possibility to select a method in the TOC. The way I had in mind was to change to a structure used by pandas and numpy with having single pages for the classes, e.g. https://pandas.pydata.org/docs/reference/api/pandas.Series.html but the downside wis that this would break all existing links. So maybe we could use this new feature to work around this and stay with our current structure.

@hagenw hagenw added the documentation Improvements or additions to documentation label Oct 24, 2022
@frankenjoe
Copy link
Collaborator

Solved with #80

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants