-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
DOC: add Sphinx roles for DOI and arXiv links #6650
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
Conversation
Could this be put in |
I think inclusion in numpydoc can be considered as a separate issue. |
My reading of numpy/numpydoc#34 is that it's not wanted in numpydoc. I'm happy to redirect it otherwise. |
Yeah I agree after reading that issue |
Looks fine to me to add this, quite small and makes the docs more uniform. Can you add a link to where you found this code? A search for |
It's from https://gist.github.com/jonls/b910afc46473b02597c4 One search line which finds it is "DOI role Sphinx". For completeness, I'll note that networkx has something similar, https://github.com/networkx/networkx/blob/master/doc/sphinxext/customroles.py |
Thanks, LGTM. |
LGTM +1 for merge |
This way, correct hyperlinks are generated automagically in the docstrings.