Skip to content

Anchors for individual sections in numpydoc doc? #317

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
Closed
zmoon opened this issue Apr 17, 2021 · 1 comment · Fixed by #320
Closed

Anchors for individual sections in numpydoc doc? #317

zmoon opened this issue Apr 17, 2021 · 1 comment · Fixed by #320

Comments

@zmoon
Copy link

zmoon commented Apr 17, 2021 •
edited
Loading

It would be nice to have those. The Sections section is pretty long. It would be easier to share the description of a specific numpydoc section if they each had their own anchor links.
@rossbar
Copy link
Contributor

rossbar commented Apr 17, 2021

Agreed, this would definitely make the docs more navigable. Switching from an enumerated list to headings for each of the elements should do it.

@rossbar rossbar mentioned this issue Apr 19, 2021
Merged
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

Successfully merging a pull request may close this issue.

DOC: Add headers to docstring sections to add link anchors rossbar/numpydoc
2 participants
@rossbar @zmoon