2017-01-20 4 views
0

私はNumPyDocスタイルのdocstringsを使ってPythonパッケージをドキュメント化しています。私は'numpydoc'スフィンクスの拡張子をNapoleonに変更したいと思います。なぜなら、私はdocstringをよりコンパクトで読みやすい方法でフォーマットしているからです。しかし、ドキュメントの一番上にあるクラスのメソッドはリストされていません。これはnumpydocの非常に貴重な機能です。誰もナポレオンで手動でこれを切り替える方法を知っていますか?NumPyDocスタイルを使ったNapoleon Sphinx拡張クラスメソッドのリスト

答えて

0

私はナポレオン/スフィンクスの新人ですが、答えはナポレオンではなくスフィンクスであると思います。

autodocをconf.pyで有効にしている場合、

extensions = ['sphinx.ext.autodoc', 
    'sphinx.ext.napoleon', 
    'sphinx.ext.coverage'] 

その後、(例えば)あなたのindex.rstに追加:module_nameが問題のクラスが含まれてい

.. autoclass:: module_name.class_name 
    :members: 
    :undoc-members: 

は、その後、class_nameは、そのメソッドのすべてと一緒にドキュメントになり、場合でも、彼ら現在docstringはありません。

関連する問題