Can't use :ref: with a Label using Sphinx doc

python-sphinx restructuredtext cross-reference
Raiu picture Raiu · Sep 2, 2015 · Viewed 9.7k times · Source

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?

Answer

user1411260 picture user1411260 · Sep 2, 2015

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>

Related questions

Adding a cross-reference to a subheading or anchor in another page

How to insert a cross-reference in a reST/Sphinx page to either a sub-header or anchor in another page in the same documentation set?

Read More
WARNING: document isn't included in any toctree for included file

I'm getting the warning: WARNING: document isn't included in any toctree for files that exist in the document because they've been explicitly included. So I have the index file: .. toctree:: :maxdepth: 2 pages/0010-foo pages/0020-bar In the file 0020-bar.rst, …

Read More
How can I link/reference another reST file in the documentation?

I have simply no idea on how can I link to another document in the reST file. I want to link a file named install.rst to my quickstart guide in a paragraph. I don't know how can I achieve …

Read More