2017-10-03 10 views
-1

私はdocstringを素敵なドキュメントページに翻訳するためにsphinx autodocを使用しています。 docstringでは、私はnumpyのdocstringガイドラインに、sphinx napoleon拡張を使っています。私は、次の疑問を抱いている:私は:label:を認識しないpythonのdocstring内のラベル

""" 
This is a very important equation which is used in the code 

.. math:: 

    a+b=c 
    :label: important_eq 
""" 

autodocのような式を持っている場合。私は間違った書式設定をしているのですか、または方程式のラベルをautodoc/mathjax/napoleonで処理できませんか?

答えて

1

空白と字下げに注意してください。これは動作します:

.. math:: 
    :label: important_eq 

    a+b=c 

これは、(数学の内容は、テキストの一行だけであるとき、それはディレクティブの引数として指定することができます)あまりにも動作します:

.. math:: a+b=c 
    :label: important_eq 
関連する問題