2

In my scipy-style docstring I have:

..., see :ref:`notes <filt_int_notes>`.

Other text.

.. _filt_int_notes:

Notes
-----
Some cool notes.

According to Adding a cross-reference to a subheading or anchor in another page and http://sphinx-doc.org/markup/inline.html#role-ref.

But the ref doesn't generate a link!

My docstrings are generated with autosummary.

Community
  • 1
  • 1
user2561747
  • 1,333
  • 2
  • 16
  • 39

1 Answers1

1

You can either use the angle brackets with text override in the ref, or leave them out. In other words, remove the angle brackets (and what's inside), unless you are going to override the text.

The error message should be better.

Gringo Suave
  • 29,931
  • 6
  • 88
  • 75