Come sottolineare il testo in reStructuredText?

Question

Naturalmente, sul web una sottolineatura indica un collegamento ipertestuale, ma cosa succede se ho bisogno di sottolineare che non è un collegamento ipertestuale?

Answer 1

Ho chiesto una domanda simile here. Prova in questo modo:

.. role:: underline 
    :class: underline 

Nel documento, questo può essere applicato come segue:

:underline:`This text is underlined` 

Nel file css si potrebbe avere:

.underline { 
    text-decoration: underline; 
} 

Questo dovrebbe funzionare per l'output HTML . Tuttavia, la sottolineatura non fa intenzionalmente parte delle specifiche ReST. Vedi this link.

Answer 2

Si aggiunge la seguente direttiva nel file index.rst ad esempio:

.. role:: underline 
    :class: underline 

Nel documento si indica il testo come sottolineato con il seguente:

:underline:`This text is underlined` 

Per specificare il css per la tua underline class aggiungi del css al file layout.html all'interno della cartella _themes/sphinx_rtd_theme/sphinx_rtd_theme/se stai usando sphinx_rtd_theme, altrimenti la tua directory tematica predefinita:

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

Questo sarà lo stile di conseguenza il tuo html.

sottolineatura fa parte del StructureText, ma non di specifiche reStructuredText della Sfinge, secondo una citazione da David Ascher nel suo 2000/01/21 Doc-SIG mailing list post, "docstring grammatica: una proposta molto rivista":

Il tagging del testo sottolineato con _'s non è ottimale. Sottolineato non deve essere utilizzato da una prospettiva tipografica (le sottolineature erano progettate per essere utilizzate nei manoscritti per comunicare al tipografo che il testo dovrebbe essere in corsivo - nessun libro ben composto utilizza mai le sottolineature ) e il conflitto con il doppio -persone Python variabile nomi (init e simili), che verrebbero troncati e sottolineato quando quell'effetto non è desiderato. Si noti che mentre il markup completo impedirebbe tale troncamento ('init'), penso ai markup docstring molto come penso alle annotazioni di tipo - dovrebbero essere facoltativo e soprattutto non fare danno. In questo caso il markup sottolineatura fa male.