search

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.13k stars 146 forks source link

Numpydoc "References" don't link properly #280

Closed corykinney closed 4 years ago

corykinney commented 4 years ago

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!

kernc commented 4 years ago

Congratz, your first issue is exemplary! :grin:

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 https://github.com/pdoc3/pdoc/pull/274.

Therefore, I suggest you use markdown footnotes, or wait for whatever we come up with in https://github.com/pdoc3/pdoc/pull/274.