sphinx-napoleon

0熱

1答えて

numpy docstringにネストされたリストをスフィンクスdocstringと組み合わせて正しく追加する方法

私は以下のことをどのように達成できるのでしょうか？私はnumpyのdocstringスタイルとsphinx autodocを組み合わせて自動化されたドキュメントを生成しています。しかし、私は出力にネストされたリストを有することをstruggelingだ： Attributes ---------- attribute 1: pandas data frame * `index:` A

python python-sphinx autodoc sphinx-napoleon 2017-09-19

---

0熱

1答えて

NumPyDocスタイルを使ったNapoleon Sphinx拡張クラスメソッドのリスト

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

python documentation numpydoc sphinx-napoleon 2017-01-20

---