問題タブ [sphinx-napoleon]
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 - Pythonの関数docstringで複数の戻り値の型を指定する方法は?
次のような Google スタイルのドキュメント文字列を作成するために使用される構文を認識しています。
しかし、実行されるコードの分岐に応じて複数の型を返すことができる関数がある場合はどうなるでしょうか? これを文書化する適切な方法は何でしょうか?
以下に例を示します。パーツには何を入れる必要がありReturnsますか？
2 つの異なる戻り値の型を示す例があります。
ただし、ナポレオンがネイティブでサポートし、ドキュメントを読みやすくするために、タイプと説明の両方を提供する最良の方法は何でしょうか。
int/str: %description%複数の戻り値の型を処理する唯一の方法は使用ですか?
python - Sphinx のパラメータ セクション外のテキスト
ナポレオン構文を使用して関数のドキュメントを書いています。ドキュメントのパラメーター リストの後に段落を追加したいと思います。現在、ドキュメントは次のようになっています。
現在、ドキュメントは (RTD テーマを使用して) 次のようにレンダリングされています。
x(a)サンプル関数。
前の宣伝文句のサンプル。
パラメータ * a ( str ) - 入力パラメータ
* ( A )の後の段落-
私が見たいのは
x(a)サンプル関数。
前の宣伝文句のサンプル。
パラメータ * a ( str ) - 入力パラメータ
一段落後。
sphinx/napoleon/rST にParametersセクションから抜け出すように指示するにはどうすればよいですか?
python - reStructuredText の代わりに Python docstring の Markdown を解釈するように Sphinx に強制する
私は Sphinx を使用して Python プロジェクトを文書化しています。docstrings で Markdown を使用して書式を設定したいと思います。拡張機能を使用しても、ドキュメント文字列ではなく、手動で記述されたファイルのみをカバーします。recommonmark.md
私は拡張機能autodocでnapoleonとを使用しています。recommonmark
docstring でsphinx 解析マークダウンを作成するにはどうすればよいですか?