2015-09-02 29 views
7

Mam problem z użyciem funkcji Ref Sphinx-doc, umieszczam etykietę powyżej akapitu, a następnie próbuję linkować do tej etykiety z innego dokumentu, ale wewnątrz tego samego projektu.Cant używać Ref z etykietą za pomocą Sphinx doc

Etykieta użyć w jednym dokumencie:

.. _hal_1k_1p: 

A Ref próbuję użyć do połączenia z tą etykietą:

:ref:`Link title hal_1k_1p` 

ale pojawia się tylko komunikat o błędzie podczas budowy doc :

UWAGA: niezdefiniowana etykieta: tytułowy związek hal_1k_1p (jeśli link nie ma podpis etykieta musi poprzedzać sektę nagłówek jonowy)

Co robię źle?

Odpowiedz

13

Ok, patrząc na http://sphinx-doc.org/markup/inline.html#role-ref trzeba mieć to:

:ref:`Link title <ha1_1k_1p>` 

link do tej etykiety.

Sprawdź, czy kątowniki otaczające etykietę tak: <etykiecie>

+1

Kiedy czytam oficjalne dokumenty dają tę odpowiedź dotyczącą mojego problemu „etykiety, które nie są umieszczone przed tytuł sekcja może być nadal odwołuje się do , ale musisz nadać linkowi wyraźny tytuł, używając następującej składni:: ref: 'Link title '. " Ale problem polega na tym, że tak naprawdę nie dają przykładu, jak to zaimplementować, Więc utknąłem – Raiu

+0

Brakowało wspornika, bardzo dziękuję – Raiu