2010-03-19 3 views
5

Comment puis-je faire référence à un élément indexé dans un document reStructuredText?Sphinx: référence croisée indexée

Par exemple, comment puis-je contre-référence SectionB:

.. index:: 
    pair: SectionA; SectionB 

SectionB 
-------- 

SectionB description. 

J'ai essayé avec :ref:'SectionB' et :index:'SectionB' mais ils ne fonctionnent pas.

Merci.

+0

utilisez-vous vraiment: ref: » SectionB 'au lieu de: ref: \ 'SectionB \'? vous devriez utiliser des guillemets ... –

+0

J'utilise des guillemets, mais Markdown les utilise comme des lignes de code en ligne, donc j'ai juste changé l'exemple pour utiliser '' – Unbeknown

Répondre

3

voir: Cross-referencing arbitrary locations

dans la documentation Sphinx.

Je pense que ce que vous pourriez manquer est un label de référence,

Essayez quelque chose comme:

.. index:: 
pair: SectionA; SectionB 

.. _section-b-label: 

SectionB 
-------- 

SectionB description. 

puis ailleurs faire:

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

Je sais que je peux utiliser des étiquettes de référence. Ce que j'essayais d'éviter, c'est d'avoir à ajouter à la fois l'index et l'étiquette de référence. Cela semble un peu redondant. – Unbeknown