2013-05-09 4 views
4

렌더링하지. 저는 파이썬 스핑크스 v1.2b에서 sphinx.ext.mathjax 확장자를 사용하고 있습니다. 문서화 문자열 : enter image description hereMathjax 표현은 내 문서화 문자열에서이 표현 뭐가 잘못 됐는지 알아 내기 위해 노력했습니다 correclty

하지만 전혀 렌더링 표현이 이상한 경고를 생성하지 계속 :

WARNING: Block quote ends without a blank line; unexpected unindent. 

을 이상하게도 내가 제거하면

.. math:: 

    w_k^* = \min_{w_k} \ell_k(w_k) + \lambda\left(\alpha||w_k||_1 
    + \frac{1}{2}(1-\alpha) ||w_k||^2\right) 

이 나타납니다 것입니다 \alpha, \left, \right, \frac 기호는 경고없이 잘 표현됩니다. 왜 \lambda이 지원되고 \alpha이 아닌지 확실하지 않습니다. Sphinx documentation에서

답변

10

:

당신이 파이썬 문서화 문자열에서 수학 마크 업을 넣을 때 autodoc 읽을 것을 명심하십시오, 당신은 (r"raw")를 모두 백 슬래시를 두 배로, 또는 파이썬 원시 문자열을 사용 중. 같은 \alpha 등이 LaTeX의 명령은, (\a와 몇 가지 다른 시퀀스 문자열 리터럴에 special meaning가) 올바르게 해석되도록

이 필요하다.

+0

감사합니다. 실제로 문제가되었습니다. 항상 모든 백 슬래시를 두 번 사용해야합니까? 나는 [numpy doscstring 표준] (https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt)을 따르려고합니다. 그러나 그들은 원시 문자열이나 이중 백 슬래시를 사용하지 않습니다. – bluecat

+0

모든 LaTeX 명령이 파이썬의 특수 이스케이프 시퀀스와 충돌하지는 않습니다. 당신은'\ lambda'가 효과가 있다고 스스로 생각했다. 따라서 ** 항상 ** 역 슬래시를 두 번 사용하거나 원시 문자열을 사용해야한다는 것은 엄격하게 사실이 아닙니다 (하지만 문제를 해결하기 위해 그렇게하는 것이 좋습니다.). w_k^* = \ min_ {w_k} \ ell_k (w_k) + \ 람다 \ 좌측 (\ 알파 || w_k || _1 + \ FRAC {1} {2 – mzjn

+0

저는 원래 방정식을 표시하는 것이 도움이 될 것이라고 생각 } (1- \ alpha) || w_k ||^2 \ right), autodoc을 파이썬 문서화 문자열 안에서 올바르게 읽으려면 어떻게 수정해야하는지 보여준다. – benjaminmgross

관련 문제