tutorial software example español apidoc python-sphinx restructuredtext

python sphinx - software - ¿Cómo hacer un enlace interno a un encabezado en sphinx restructuredtext sin crear etiquetas arbitrarias?



sphinx software (3)

Una pequeña adición a la respuesta de Chris:

Si desea enlazar a los encabezados sin usar el nombre exacto de ese encabezado para el enlace, puede hacerlo de la siguiente manera:

Titles are targets, too ======================= See `here <#titles-are-targets-too>`_

Esto se procesará como:

<h1 id="titles-are-targets-too">Titles are targets, too</h1> <p>See <a href="#titles-are-targets-too">here</a></p>

Tengo un documento con muchos títulos y subtítulos. Más adelante en el texto quiero enlazar de nuevo a uno de los encabezados. ¿Cómo puedo hacer esto sin la redundancia de :ref: labels? El contenido parece recoger encabezados muy bien. Esperaba algo como esto: `#polled-data-retrieval`_ .


reStructuredText admite destinos de hipervínculo implícitos . De la referencia rápida reStructuredText :

Los títulos de las secciones, las notas al pie y las citas generan automáticamente objetivos de hipervínculo (el texto del título o la etiqueta de la nota al pie / cita se utiliza como nombre del hipervínculo).

Entonces, el siguiente texto (extraído de la referencia rápida reStructuredText, errores de ortografía y todo):

Titles are targets, too ======================= Implict references, like `Titles are targets, too`_.

produce HTML similar al siguiente:

<strong><a name="title">Titles are targets, too</a></strong> <p>Implict references, like <a href="#title">Titles are targets, too</a>.</p>


¡Nueva, mejor respuesta para 2016!

La extensión de autosección le permite hacer esto fácilmente, con referencias cruzadas reales.

============= Some Document ============= Internal Headline =================

Entonces despúes...

=============== Some Other Doc =============== A link- :ref:`Internal Headline`

Esta extensión está incorporada, por lo que todo lo que necesita es editar conf.py

extensions = [ . . other . extensions . already . listed . ''sphinx.ext.autosectionlabel'', ]

Lo único que debes tener en cuenta es que ahora no puedes duplicar los titulares internos en toda la colección de documentos. (Vale la pena.)