Skip to content
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

Closed
corykinney opened this issue Oct 28, 2020 · 1 comment
Closed

Numpydoc "References" don't link properly #280

corykinney opened this issue Oct 28, 2020 · 1 comment
Labels
duplicate This issue or pull request already exists

Comments

@corykinney
Copy link

corykinney commented Oct 28, 2020

Expected Behavior

Numpydoc section 14 provides the following syntax for creating a reference inside a References section

.. [1] O. McNoleg, "The integration of GIS, remote sensing,
   expert systems and adaptive co-kriging for environmental habitat
   modelling of the Highland Haggis using object-oriented, fuzzy-logic
   and neural-network techniques," Computers & Geosciences, vol. 22,
   pp. 585-588, 1996.

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!

@corykinney corykinney changed the title Numpydoc "References" Numpydoc "References" don't link properly Oct 28, 2020
@kernc
Copy link
Member

kernc commented Oct 28, 2020

Congratz, your first issue is exemplary! 😁

Numpydoc section 14 provides the following syntax for creating references

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.

@kernc kernc closed this as completed Oct 28, 2020
@kernc kernc added the duplicate This issue or pull request already exists label Oct 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists
Development

No branches or pull requests

2 participants