numpy / numpydoc

Numpy's Sphinx extensions
https://numpydoc.readthedocs.io/
Other
302 stars 161 forks source link

Wish: link anchors for docstring sections #88

Open jnothman opened 7 years ago

jnothman commented 7 years ago

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.

pv commented 7 years ago

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