Как подчеркнуть текст в reStructuredText? - PullRequest
Новая
       2

Как подчеркнуть текст в reStructuredText?

18 голосов
/ 31 января 2012

Конечно, в Интернете подчеркивание обозначает гиперссылку, но что, если мне нужно подчеркнуть, что это не гиперссылка?

Ответы [ 2 ]

28 голосов
/ 01 февраля 2012

Я задал похожий вопрос здесь .Попробуйте так: 

.. role:: underline
    :class: underline

В документе это может быть применено следующим образом: 

:underline:`This text is underlined`

В вашем файле css может быть: 

.underline {
  text-decoration: underline;
}

Это должно работать для вывода HTML.Тем не менее, подчеркивание намеренно не является частью спецификации ReST.Смотрите эту ссылку .

1 голос
/ 21 октября 2015

Вы добавляете следующую директиву в файл 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, согласно цитате Дэвида Ашера в его посте списка рассылки Doc-SIG за 2000-01-21 «Грамматика Docstring: очень пересмотренное предложение»:

Пометка подчеркнутого текста символом _ неоптимальна. подчеркивает не следует использовать с типографской точки зрения (подчеркивания были предназначен для использования в рукописях для связи с наборщиком что текст должен быть выделен курсивом - ни одна хорошо набранная книга никогда не использует подчеркивается) и конфликтует с двойной подчеркиванием переменной Python имена ( init и т. п.), которые будут обрезаны и подчеркнуто, когда этот эффект не желателен. Обратите внимание, что пока завершено Я думаю, что разметка предотвратит это усечение (' init ') разметки документации очень похожи на аннотации типов - они должны быть необязательным и, прежде всего, не навреди. В этом случае подчеркивание разметка наносит вред.

...