Как предотвратить преобразование символов в Sphinx?

Вопрос или проблема

vim test.rst
тест
==============
это "тест"

это “тест”

это "тест"

Ответ или решение

Чтобы предотвратить преобразование определенных символов, таких как одинарные и двойные кавычки, в систему Sphinx при использовании reStructuredText (reST), необходимо воспользоваться несколькими подходами. Sphinx может автоматически преобразовывать простые кавычки в типографские символы, такие как «’» и «“», что может не соответствовать вашим требованиям. Вот несколько способов решения этой проблемы.

1. Использование обратного слэша

Одним из самых простых способов предотвратить автоматическое преобразование — это использовать обратный слэш для экранирования символов. Например:

test
==============
it\'s a \"test\"

2. Использование текста в кавычках

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

test
==============
'it's a "test"'

3. Установка конфигурации Sphinx

Проверка конфигурации вашего проекта Sphinx также может помочь в этом вопросе. Откройте файл conf.py, который обычно находится в директории вашего проекта Sphinx. Найдите настройки, относящиеся к обработке текста, и убедитесь, что параметры "smartquotes" отключены.

# Убедитесь, что этот параметр выключен
smartquotes = False

Таким образом, вы предотвратите автоматическое преобразование кавычек в типографические формы.

4. Использование разметки |

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

.. raw:: html

   it's a "test"

5. Проверка используемой версии Sphinx

Иногда поведение Sphinx может зависеть от версии. Убедитесь, что у вас установлена актуальная версия Sphinx, и ознакомьтесь с документацией для вашей версии. В некоторых версиях могут быть изменения в обработке текста, которые могут повлиять на ваш результат.

Заключение

Следуя вышеуказанным рекомендациям, вы сможете настроить Sphinx так, чтобы он корректно отображал текст без нежелательного преобразования кавычек. Если после применения этих методов проблема не устраняется, рекомендуется обратиться к документации Sphinx или просмотреть соответствующие обсуждения в сообществах разработчиков, где можно найти специфические решения для вашей ситуации.

Таким образом, используя приведенные методы, вы сможете сохранить нужные символы в своем файле, делая процесс редактирования более комфортным и понятным.