¿Cómo subrayar el texto en reStructuredText?

Question

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

Answer 1

Hice una pregunta similar here. Trate de esta manera:

.. role:: underline 
    :class: underline 

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

:underline:`This text is underlined` 

En el archivo css que podría tener:

.underline { 
    text-decoration: underline; 
} 

Esto debería funcionar para la salida HTML . Sin embargo, subrayar no es intencionalmente parte de las especificaciones ReST. Ver this link.

Answer 2

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

.. role:: underline 
    :class: underline 

En el documento se indica el texto subrayado con lo siguiente:

:underline:`This text is underlined` 

Para especificar el CSS para su clase de subrayado agrega un poco de CSS al archivo layout.html dentro de la carpeta _themes/sphinx_rtd_theme/sphinx_rtd_theme/si está utilizando sphinx_rtd_theme; de ​​lo contrario, su directorio de temas predeterminado:

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

Esto dará estilo a su html en consecuencia.

El subrayado es parte de la StructureText pero no de las especificaciones reStructuredText de Sphinx, de acuerdo con una cita de David Ascher en su 2000-01-21 Doc-SIG lista de distribución de correos, "docstring gramática: una propuesta muy revisada":

El etiquetado de texto subrayado con _ es inferior al óptimo. Los subrayados no deben utilizarse desde una perspectiva tipográfica (los subrayados fueron diseñados para ser utilizados en manuscritos para comunicar al tipógrafo que el texto debe estar en cursiva, ningún libro bien redactado usa subrayados), y entran en conflicto con el doble -underscored Python variable nombres (init y similares), que se truncarían y subrayado cuando no se desea ese efecto. Tenga en cuenta que si bien el marcado completo prevendría ese truncamiento ('init'), pienso en marcas de docstring, al igual que en las anotaciones tipo - deberían ser ser opcionales y sobre todo no dañar. En este caso, el marcado subrayado daña.