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

Numpydoc new feature to cross-reference type #20

Closed

saimn opened this issue Apr 23, 2019 · 1 comment · Fixed by #40

Contributor

saimn commented Apr 23, 2019

Numpydoc 0.9 has a nice new feature to automatically cross-reference types:
https://github.com/numpy/numpydoc/pull/197/files#diff-b50754a7065a1dece18f634c6b5b2633
(their docs build is outdated, so I'm linking directly the PR).
It allows to link automatically the Python types, but also all references from intersphinx, and user defined aliases for specific terms like array_like.
I have been playing with this in MPDAF and it works quite well, even if themes need to be updated for a better rendering:
https://git-cral.univ-lyon1.fr/MUSE/mpdaf/blob/master/doc/conf.py#L89-102

The text was updated successfully, but these errors were encountered:

Member

bsipocz commented Apr 23, 2019

This would be very nice to have!

nstarman mentioned this issue

intersphinx xref #40

Merged

saimn closed this as completed in #40

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment