Показать две черты в первом файле - PullRequest
0 голосов
/ 28 июня 2018

Я пишу первый файл и планирую отобразить следующее:

команда -abc --efg

Я пробовал несколько способов избежать тире, когда две черты вместе, но я не могу получить то, что хочу в скомпилированном документе. Вот несколько вещей, которые я попробовал:

command -abc --efg
command -abc \--efg
command -abc -\-efg
command -abc \-\-efg
command -abc \--\--efg

Есть предложения?

1 Ответ

0 голосов
/ 28 июня 2018

В зависимости от вашей версии Sphinx, у вас может быть html_use_smartypants=True (Sphinx <1.6.6) или <a href="http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-smartquotes" rel="nofollow noreferrer">smartquotes=True (Sphinx ≥ 1.6.6). Если вы пропустите параметр из conf.py или при вызове sphinx-build, то будет действовать значение по умолчанию True, преобразующее двойную черту "--" в типографскую черту "-". См. Смарт-цитаты для Docutils, описание для всех преобразований.

Вы можете экранировать каждый символ в двойном тире, но это некрасивая разметка, и дисплей не отличается от встроенного текста.

command -abc \\-\\-efg

Чтобы отобразить встроенную команду, окружите ее двойными галочками. Дисплей различим как команда.

Enter the command ``command -abc --efg`` to do stuff.

Чтобы отобразить команду в отдельном блоке текста, используйте .. code-block::.

.. code-block:: bash

    command -abc --efg

Отображение приведенных выше примеров:

Rendered display of above examples

...