問題タブ [numpydoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - Sphinx autosummary は、クラスごとに 2 つの要約を生成します
Sphinx+autodoc+autosummary を使用して、プロジェクトのドキュメントを生成しています ( mrpy)。
私は2層の要約を行っています。どこにindex.rst（最小限）ありますか
ご覧のとおり、モジュール レベルのオートサマリーにはカスタム テンプレートを使用しています。これにより、モジュール レベルの概要で、モジュール内のオブジェクトの概要も得られ、それぞれが独自のページにリンクされます。参考までに、私のmodules.rstファイルは
mrpy.statsには 3 つのクラスしか含まれていませんが、インデックス ページに作成された表のリンクをたどると、美しく要約されます。これらのクラスの 1 つへのリンクをたどるとき、別のカスタム テンプレートを使用しますclass.rst。
ただし、このクラスのページには、予想どおりタイトルとクラス docstring が含まれていますが、クラスのメソッドと属性の2 つの表形式の要約が含まれています。
冗長なテーブルの 1 つを取り除く方法を知っている人はいますか?
python - Sphinx 予期しないセクション タイトル - numpydoc
numpy 形式で Sphinx を正しく動作させることができません。「make html」を実行してこの例でテストしていますが、パラメータ、メモ、戻り値などを認識するためのいくつかの警告が表示されます。例:
この質問はすでに尋ねられていますが、何時間も検索して試しても成功しません。
私が今までやってきたこと：
- Sphinx v1.3.5をインストール
numpydocバージョン0.5にアップデート- 拡張子
numpydoc、sphinxcontrib.napoleon、およびsphinx.ext.napoleonをconf.pyファイルに追加しました。 - rst2html docum.txt docum.html を試しました
- numydocを使っていないと思っていたので拡張子に間違った名前を書いてしまいエラーになりました(本来ならnumpydocを特定していると思います)。
numpydoc_show_class_members = Falseに追加conf.py- 以前のhtml出力全体を削除する
何が間違っているかの提案やヒントはありますか? 何を試すことができますか？
ありがとう
python - sphinxcontrib.napoleon と numpy.numpydoc の違い
Numpy スタイルの docstringsを使用して Python プロジェクトのドキュメントを作成しています。
numpydocとnapoleonは、Numpy スタイルの docstring を解析してドキュメントを生成する 2 つの Sphinx 拡張機能です。1 つ目は Numpy プロジェクト自体に使用され、2 つ目は Sphinx に同梱されています。
ある拡張機能を他の拡張機能よりも使用することの長所と短所は何ですか?
python - numpydoc の規則: メソッドはクラスを変更しますが、何も返しません
numpydoc docstring 規則に関する質問:
何も返さないが、クラスに属性を追加するいくつかのメソッドを含むクラスがあります。例えば：
この不器用な例では、MyClass.a_multは何も返しませんが、属性を に追加しますMyClass。
numpydocスタイル ガイドMyClass.a_multに従うための docstring を含めました。docstring には、メソッドが None を返すと記載されていますが、メソッドがインスタンスを変更する方法を文書化する標準的な方法がわかりません。MyClass.a_multMyClass
よろしくお願いします。