Jak podkreślić tekst w reStructuredText?

Question

Oczywiście w Internecie podkreślenie oznacza hiperłącze, ale co jeśli potrzebuję podkreślić, które nie jest hiperłączem?

Answer 1

Poprosiłem o podobne pytanie here. Spróbuj tak:

.. role:: underline 
    :class: underline 

W dokumencie tym mogą być stosowane w sposób następujący:

:underline:`This text is underlined` 

W pliku css można mieć:

.underline { 
    text-decoration: underline; 
} 

ten powinien pracować dla wyjścia HTML . Jednak podkreślanie celowo nie jest częścią specyfikacji ReST. Zobacz this link.

Answer 2

dodać następującą dyrektywę w pliku index.rst na przykład:

.. role:: underline 
    :class: underline 

W dokumencie można wskazać tekst jak podkreślono następujące warunki:

:underline:`This text is underlined` 

Aby określić css dla Twoja klasa podkreślenia dodajesz css do pliku layout.html w folderze _themes/sphinx_rtd_theme/sphinx_rtd_theme/jeśli używasz sphinx_rtd_theme, w przeciwnym razie domyślny katalog tematyczny:

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

Spowoduje to odpowiednie ułożenie html.

Podkreślenie jest częścią StructureText ale nie specyfikacji reStructuredText Sfinksa, zgodnie z cytatem z David Ascher w swojej 2000-01-21 Doc-SIG listy mailingowej post „Docstring gramatyka: bardzo zmieniony wniosek”:

Znakowanie podkreślonego tekstu znakami _ jest nieoptymalne. Podkreślenia nie powinny być używane z perspektywy typograficznej (podkreślenia to: przeznaczone do użycia w manuskryptach do komunikowania się z maszyną do pisania , że tekst powinien być zaznaczony kursywą - podkreślenie nie ma dobrze przygotowanej książki, a konflikt z podwójnym -odnotowane zmienne Python nazwy (init i tym podobne), które zostałyby obcięte, a podkreślone, gdy efekt ten nie jest pożądany. Zauważ, że podczas gdy całkowity znacznik uniemożliwiłby to obcięcie ("init"), myślę o znacznikach docstringowych, podobnie jak myślę o adnotacjach typu - powinny one być opcjonalne i przede wszystkim nie szkodzić. W tym przypadku znacznik jest szkodliwy.