タグ付けされた質問 「autodoc」

Sphinxを使用して5,000行以上のプロジェクトをPythonでドキュメント化しようとしています。約7つの基本モジュールがあります。私の知る限り、autodocを使用するには、プロジェクト内の各ファイルに対して次のようなコードを記述する必要があります。 .. automodule:: mods.set.tests :members: :show-inheritance: 多くのファイルを持っているので、これは非常に面倒です。「mods」パッケージを文書化することを指定できれば、はるかに簡単になります。Sphinxはパッケージを再帰的に調べ、各サブモジュールのページを作成します。 このような機能はありますか？そうでない場合、すべての.rstファイルを作成するスクリプトを作成できますが、これには多くの時間がかかります。

149 python  python-sphinx  autodoc 

Sphinxはデフォルトでは__init __（self）のドキュメントを生成しません。私は以下を試しました： .. automodule:: mymodule :members: そして ..autoclass:: MyClass :members: conf.pyで、次の設定は__init __（self）docstringをクラスdocstringに追加するだけです（Sphinx autodocドキュメントはこれが予想される動作であることに同意しているようですが、私が解決しようとしている問題については何も言及していません）。 autoclass_content = 'both'

107 python  python-sphinx  autodoc 

私はSphinxを使い始めようとしていますが、容赦ない問題があるようです。 コマンド： docs/sphinx-quickstart 私はすべての質問に答え、すべてがうまくいきます。 コマンド： docs/ls すべてが正常に見えます。結果：build Makefile source コマンド： sphinx-build -d build/doctrees source build/html 動作するようです。index.htmlファイルを開いて、必要なものの「シェル」を表示することができました。 実際のソースコードをsourceフォルダーとして配置しようとすると、問題が発生します。 コマンド： sphinx-build -d build/doctrees ../ys_utils build/html 結果： Making output directory... Running Sphinx v1.1.3 loading pickled environment... not yet created No builder selected, using default: html loading intersphinx inventory from http://docs.python.org/objects.inv... building [html]: targets …

104 python  python-sphinx  autodoc 

私はsphinxとautodocプラグインを使用して、PythonモジュールのAPIドキュメントを生成しています。特定のパラメーターを適切に文書化する方法はわかりますが、**kwargsパラメーターを文書化する方法の例は見つかりません。 これらを文書化する明確な方法の良い例は誰にもありますか？

99 python  python-sphinx  autodoc