Конечно, в Интернете подчеркивание обозначает гиперссылку, но что, если мне нужно подчеркнуть, что не является гиперссылкой?
Я задал аналогичный вопрос здесь. Попробуйте вот так:
.. role:: underline
:class: underline
В документе это можно применить следующим образом:
:underline:`This text is underlined`
В вашем файле css вы можете:
.underline {
text-decoration: underline;
}
Это должно работать для вывода HTML. Тем не менее, подчеркивание намеренно не входит в спецификации REST. См. эту ссылку.
Вы добавляете следующую директиву в файл index.rst, например:
.. role:: underline
:class: underline
В документе вы указываете текст как подчеркнутый со следующим:
:underline:`This text is underlined`
Для того, чтобы указать CSS для вашего класса подчеркивания вы добавить CSS в layout.html файл в папке _themes/sphinx_rtd_theme/sphinx_rtd_theme/если вы используете sphinx_rtd_theme, в противном случае вашего каталога темы по умолчанию:
<style>
.underline {
text-decoration: underline;
}
</style>
Это будет соответствующим образом оформлять ваш html.
Подчеркивание является частью StructureText, но не спецификаций Sphinx ReStructuredText, согласно цитате из Дэвид Ашер в своем 2000-01-21 Doc-SIG в почтовой рассылке, "строка документации грамматика: очень пересмотренное предложение":р >
Тегирование подчеркнутого текста с помощью _ является неоптимальным. подчеркивает не следует использовать с типографской точки зрения (подчеркивались предназначенные для использования в рукописях для связи с наборомщиками что текст должен быть выделен курсивом - ни одна из набережных книг никогда не использует подчеркивает) и конфликтует с двунаправленной переменной Python имена (init и т.п.), которые будут усечены и подчеркнуто, когда этот эффект нежелателен. Обратите внимание, что при завершении разметка предотвратит это усечение (' init), я думаю о docstring накладывается так, как будто я думаю о аннотациях типа - они должны быть необязательным и, прежде всего, не навредить. В этом случае подчеркивание разметка наносит ущерб.