-
-
Notifications
You must be signed in to change notification settings - Fork 145
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
Numpydoc "References" don't link properly #280
Comments
Congratz, your first issue is exemplary! 😁
This is really a reStructuredText syntax for anchors/links. Works outside Numpydoc sections just as well, provided the underlying style/format is reStructuredText ... In pdoc, however, the underlying syntax is Markdown, and various Googledoc/Numpydoc (+some reST) particularities are just mocked for by way of simple transformations into markdown. Support for raw reST is just being worked on in #274. Therefore, I suggest you use markdown footnotes, or wait for whatever we come up with in #274. |
Expected Behavior
Numpydoc section 14 provides the following syntax for creating a reference inside a References section
that can be linked in a Notes section with the following syntax
[1]_
.Actual Behavior
The reference displays as raw strings with no link.
Additional info
pdoc version: 0.9.1
This is my first time submitting an issue on GitHub and today is my first day using Numpydoc/pdoc, so if I'm doing something wrong just let me know!
The text was updated successfully, but these errors were encountered: