numpydoc icon indicating copy to clipboard operation
numpydoc copied to clipboard

Wish: link anchors for docstring sections

Open jnothman opened this issue 8 years ago • 1 comments

It would be great if each docstring section had its own link anchor (perhaps with corresponding sphinx role, or perhaps just a ref for simplicity), and even better if each entry in a parameter list had its own link anchor.

Given these link anchors, linking generated parameter names in function singatures to their respective descriptions would be wonderful.

jnothman avatar Feb 07 '17 06:02 jnothman

The sphinx .. rubric:: that doesn't add them was used here iirc is because underline titles don't work inside auto-docstrings.

pv avatar Feb 07 '17 09:02 pv