2010-03-19 5 views
5

Wie kann ich einen indizierten Artikel in einem reStructuredText-Dokument referenzieren?Sphinx: Querverweis indizierter Artikel

Zum Beispiel, wie kann ich Verweis überqueren SectionB:

.. index:: 
    pair: SectionA; SectionB 

SectionB 
-------- 

SectionB description. 

Ich versuchte :ref:'SectionB' und :index:'SectionB' verwenden, aber sie funktionieren nicht.

Danke.

+0

sind Sie wirklich mit: ref:‘ AbschnittB 'anstelle von: ref: \ 'AbschnittB \'? Sie sollten Backticks verwenden ... –

+0

Ich benutze Backticks, aber Markdown verwendet sie als Inline-Code-Spannen, also habe ich nur das Beispiel geändert, um '' – Unbeknown

Antwort

3

sehen: Cross-referencing arbitrary locations

in der Sphinx-Dokumentation.

Ich denke, was Sie vielleicht fehlt ein Referenzetikett ist,

Versuchen Sie so etwas wie:

.. index:: 
pair: SectionA; SectionB 

.. _section-b-label: 

SectionB 
-------- 

SectionB description. 

und führen Sie dann an anderer Stelle:

:ref:`section-b-label` 
+5

zu verwenden Ich weiß, dass ich Referenzlabels verwenden kann. Was ich vermeiden wollte, ist, dass ich sowohl den Index als auch das Referenzlabel hinzufügen muss. Es scheint ein bisschen überflüssig. – Unbeknown

Verwandte Themen