rst - ¿Cómo subrayar el texto en reStructuredText?

rst text

Question

Por supuesto, en la web, un subrayado denota un hipervínculo, pero ¿qué pasa si necesito subrayar que no es un hipervínculo?

Answer 1

Agregue la siguiente directiva en el archivo index.rst por ejemplo:

.. role:: underline
    :class: underline

En el documento indicas el texto como subrayado con lo siguiente:

:underline:`This text is underlined`

Para especificar el css para su clase de subrayado, agregue algo de css al archivo layout.html dentro de la carpeta _themes / sphinx_rtd_theme / sphinx_rtd_theme / si está usando sphinx_rtd_theme; de ​​lo contrario, su directorio de tema predeterminado:

<style>
    .underline {
    text-decoration: underline;
  }
</style>

Esto estilizará su html en consecuencia.

El subrayado es parte del texto de estructura pero no de las especificaciones de texto estructurado de Sphinx, según una cita de David Ascher en su publicación de la lista de correo Doc-SIG 2000-01-21, "Docstring grammar: una propuesta muy revisada":

El etiquetado de texto subrayado con _ es subóptimo. Los subrayados no se deben usar desde una perspectiva tipográfica (los subrayados se diseñaron para ser usados ​​en manuscritos para comunicar al tipógrafo que el texto debe estar en cursiva, ningún libro de texto tipográfico usa subrayados), y entra en conflicto con la variable Python con doble subrayado nombres ( init y similares), que se truncarían y subrayarían cuando no se desea ese efecto. Tenga en cuenta que si bien el marcado completo evitaría ese truncamiento ('' init ''), pienso en el marcado de cadenas de documentación de la misma manera que pienso en las anotaciones de tipo: deberían ser opcionales y, sobre todo, no hacer daño. En este caso el marcado de subrayado hace daño.

Answer 2

Hice una pregunta similar here . Prueba de esta manera:

.. role:: underline
    :class: underline

En el documento, esto se puede aplicar de la siguiente manera:

:underline:`This text is underlined`

En tu archivo css puedes tener:

.underline {
  text-decoration: underline;
}

Esto debería funcionar para la salida HTML. Sin embargo, el subrayado no es intencionalmente parte de las especificaciones de ReST. Vea este enlace .