Я пытаюсь сделать три действительно простых вещи в многострочном математическом режиме в Sphinx (версия 1.1.2-1).

Напишите подчеркивание как часть моих имен переменных даже в математическом режиме;Использовать ,\big\bigglи т. д., разделители для создания больших скобок и скобок;и включить обычный текст как часть уравнений.

Обратите внимание на следующие две вещи. (1) Я использую необработанную строку в своем коде Python для документации по разметке Sphinx, поэтому для обратных символов не требуется дополнительная обратная косая черта, и (2) я не использую встроенный математический режим, который в Sphinx разграничивается следующим образом:

:math:`Some math stuff goes here` regular text could go here...

Вместо этого я делаю многострочный материал, частоeqnarray в латексе:

.. math::
    DividendYield &=& \frac{DVT(t)}{CurrentMarketCap} \\
    Avg_Assets &=& \biggl( A/B \biggr) \textrm { when B is not zero...}

В настоящее время я получаю ошибки Sphinx (и сгенерированные страницы документа выглядят как бред), которые говорят что-то вроде:

Unknown LaTeX command: textrm

То же самое происходит для\biggl, Для подчеркивания он просто всегда интерпретирует это, как будто я обозначаю индекс, но если я использую\textunderscore или другие трюки, то он выдает те же виды ошибок, что и выше.

Подчеркивает в математическом режиме,textrm команда, и большие разделители являются чрезвычайно основными частями каждого собственного пакета TeX, который ямы когда-либо использовали. Так почему же они недоступны через Сфинкса?

Обновить

Один конкретный файл Python, над которым я работаю, вычисляет для меня данные Book Equity. Итак, ниже, когда вы видите материал о BookEquity, этоссылка. Я могу'Мы не запускаем процесс build-docs, кроме как через систему контроля версий, поэтому сделать воспроизводимую ошибку было бы проще всего, если я просто изменил существующий файл.

Однако все, что я сделал, это добавил следующую функцию класса в свой код с простой строкой документации.

def foo(self):
    r"""
    Sample docstring

    .. math::
        Ax &=& b \\
        Cx &=& \biggl(\frac{x/y}\biggr) \textrm{ if y is not zero.}
    """
    pass

И затем изображение ниже - это результат создания документации с помощью Sphinx 1.1.2-1.

Если вы щелкните правой кнопкой мыши и выберите «просмотреть изображение Вы можете увидеть лучшую версию.