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

[docs bug] Incorrect toctree section structure #9

Closed
ain-soph opened this issue Dec 8, 2021 · 3 comments
Closed

[docs bug] Incorrect toctree section structure #9

ain-soph opened this issue Dec 8, 2021 · 3 comments

Comments

@ain-soph
Copy link
Owner

ain-soph commented Dec 8, 2021

This bug is from the upstream autoapi plugin:

The maintainer of autoapi claims that it can't be fixed currently because sphinx provides limited support to modify the toctree (In issue 283).

The temporary workaround is that don't create sections when you have functions and classes which require documentation in that rst file, Or -- Simply just don't use it and use the official ext.autodoc plugin.
@ain-soph
Copy link
Owner Author

ain-soph commented Dec 9, 2021

This shall be transferred to alpsplot repo which uses the autoapi plugin, since it's irrelevant with this theme.

@ain-soph ain-soph transferred this issue from ain-soph/trojanzoo_sphinx_theme Dec 9, 2021
@ain-soph ain-soph changed the title [bug] Incorrect toctree section structure [docs bug] Incorrect toctree section structure Dec 9, 2021
@ain-soph
Copy link
Owner Author

ain-soph commented Jan 9, 2023

I shall fix this since sphinx-doc/sphinx#6316 is already published.

@ain-soph
Copy link
Owner Author

Completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ain-soph