Próbuję zrobić trzy naprawdę podstawowe rzeczy w trybie wieloliniowym w Sphinx (wersja 1.1.2-1).

Pisz podkreślenia jako część moich nazw zmiennych nawet w trybie matematycznym;Użyj\big, \bigglitd. ograniczniki do tworzenia dużych nawiasów i nawiasów;i dołącz regularny tekst jako część równań.

Zwróć uwagę na następujące dwie rzeczy. (1) Używam nieprzetworzonego ciągu w moim kodzie Pythona do dokumentacji znaczników Sphinx, więc dodatkowe ukośniki nie są potrzebne dla znaków ucieczki, oraz (2) Nie wykonuję wbudowanego trybu matematycznego, który jest rozdzielony w ten sposób w Sphinx:

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

Zamiast tego robię rzeczy wieloliniowe, często jakeqnarray w LaTeX:

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

Obecnie otrzymuję błędy Sphinx (a wygenerowane strony doc wyglądają jak bełkot), które mówią:

Unknown LaTeX command: textrm

To samo dzieje się z\biggl. Dla podkreślenia zawsze interpretuje to tak, jakbym oznaczał indeks dolny, ale jeśli go użyję\textunderscore lub inne sztuczki, a następnie rzuca takie same błędy jak powyżej.

Podkreśla w trybie matematycznymtextrm Polecenie, a duże ograniczniki są niezwykle podstawowymi częściami każdego rodzimego pakietu TeX-a, jakiego kiedykolwiek użyłem. Dlaczego więc są niedostępne przez Sfinksa?

Aktualizacja

Jeden konkretny plik Pythona, nad którym pracuję, oblicza dane Book Equity dla mnie. Więc poniżej, kiedy widzisz rzeczy o BookEquity, to jest odniesienie. Nie mogę uruchomić naszego procesu budowania dokumentów, za wyjątkiem systemu kontroli wersji, więc wykonanie powtarzalnego błędu było najłatwiejsze, gdy zmodyfikowałem istniejący plik.

Jednak wszystko, co zrobiłem, to dodanie następującej funkcji klasy do mojego kodu, za pomocą prostego docstringu.

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

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

A następnie obraz poniżej to wynik pochodzący z budowania dokumentów za pomocą Sphinx 1.1.2-1.

Jeśli klikniesz prawym przyciskiem myszy i wybierzesz „wyświetl obraz”, zobaczysz lepszą wersję.