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

autodoc: option to add anchors to classes and methods #6894

Closed
pawamoy opened this issue Dec 6, 2019 · 1 comment
Closed

autodoc: option to add anchors to classes and methods #6894

pawamoy opened this issue Dec 6, 2019 · 1 comment

Comments

@pawamoy
Copy link

pawamoy commented Dec 6, 2019

Is your feature request related to a problem? Please describe.
No, not really. It's just an UX issue. I use autodoc to auto-document classes. These classes often have a lot of methods, with long docstrings and lots of parameters, so the generated page is quite long, making it difficult to search for a particular method (Ctrl-F, I know) or have an overview of what methods the class provides. The actual problem is that I cannot (neither manually or using autodoc's options) make autodoc write anchors (headings?) for each class and method. Being able to add anchors (headings?) would allow to display them in the sidebar.

Describe the solution you'd like
I would like an autodoc option that makes it write classes or methods signatures with an anchor, so they can appear in the sidebar, effectively improving navigation in long, auto-generated reference pages.

Describe alternatives you've considered
Customize the theme used? But then it would only work for that particular theme 😕 And how would I do that? With javascript, dynamically modifying the sidebar, searching for classes and methods signatures? Seems hacky 😕

Additional context

@pawamoy pawamoy added the type:enhancement enhance or introduce a new feature label Dec 6, 2019
@pawamoy pawamoy changed the title autodoc: option add anchors to classes and methods autodoc: option to add anchors to classes and methods Dec 6, 2019
@tk0miya
Copy link
Member

tk0miya commented Dec 7, 2019

Thank you for reporting. But this is duplicated with #6316. Closing.

@tk0miya tk0miya closed this as completed Dec 7, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants