17

I have a problem with using Sphinx-doc's :ref: role, I put a label above a paragraph and then I try to link to that label from another doc but inside the same project.

The label I use in one document:

.. _hal_1k_1p:

And the ref I try to use to link to that label:

:ref:`Link title hal_1k_1p`

But I only get this error message when building the doc:

WARNING: undefined label: link title hal_1k_1p (if the link has no caption the label must precede a section header)

What am I doing wrong?

bad_coder
  • 5,829
  • 13
  • 26
  • 41
Raiu
  • 175
  • 1
  • 1
  • 6

1 Answers1

28

Okay, looking at :ref: you need to have this:

:ref:`Link title <ha1_1k_1p>`

to link to that label.

Ensure you have angle brackets surrounding your label like so: <label>

return42
  • 455
  • 3
  • 9
user1411260
  • 513
  • 4
  • 5
  • 1
    When i read the official docs they give this answer regarding my problem "Labels that aren’t placed before a section title can still be referenced to, but you must give the link an explicit title, using this syntax: :ref:`Link title `." But the problem is that they dont really give an exempel of how to implement it, So im kinda stuck – Raiu Sep 02 '15 at 18:47
  • 5
    also note that the label definition **does** include the `_` at the beginning while the label usage does **not** include the `_` character – Hubert Kario Oct 20 '19 at 18:39