私はnumpyのドキュメントストリングのガイドラインに従って私のドキュメントストリングを書いています。それから、私はドキュメントを生成するためにsphinxのautodocを使用します。いくつかのドキュメントストリングの中で私はLaTeX式(sphinx.ext.mathjax)を使用しています。 \r
は新しい行のような特別な意味を持つようです。次のコマンドがある場合:スフィンクスには何かがありますか?
"""
This :math:`\langle a, b\rangle` denotes the dot product of a and b
"""
正しく表示されません。 インラインで解釈されるテキストまたはフレーズ参照の開始文字列(末尾文字列なし) \ rangleを\ langleに置き換えると、すべて正常に動作します。これをどうすれば解決できますか?そこ
r"""
This :math:`\langle a, b\rangle` denotes the dot product of a and b
"""
:
はスフィンクスだけではなく、法的SphinxQLスペースになりましhttp://sphinxsearch.com/bugs/view.php?id=332 – planet260
です - '\ r'は多くの場所での改行文字です。コメントのために – jonrsharpe
@ planet260 thxしかし、どうすればこの作業をすることができますか? – math