問題タブ [sphinx-apidoc]

rstを含むファイルで Sphinx を実行していますautomoduleが、効果がないようです。

詳細は次のとおりです。agent.pyクラスを含むファイルを含むPythonプロジェクトがありますAgent。apidocファイルを含むサブディレクトリもありますagent.rst（によって生成されますsphinx-apidoc）：

sphinx-build -b html apidoc apidoc/_buildプロジェクトのディレクトリを現在の作業ディレクトリとしてsphinx を実行します。

Python ファイルが確実に見つかるように、次のファイルを に含めましたapidoc/conf.py。

エラーなしで実行されますが、結果の HTML ファイルを開くと、「エージェント モジュール」しか表示されず、すべてが空白です。Agentクラスとそのメンバーが表示されないのはなぜですか?

更新: 元の問題は、私sphinx.ext.autodocがconf.py. しかし、今では、次のような警告が表示されます。

Re:拡張機能sphinx-apidocを介して docstring から API リファレンスを自動生成するために使用しています...autodoc

/site-packages/sphinx/templates/apidoc/package.rst_tグローバルテンプレートをローカル フォルダーにコピーし、ナンセンスな編集を行いました。API ドキュメントを作成したとき、意味のない編集は表示されませんでした。ローカル テンプレートがグローバル テンプレートをオーバーライドしているようには見えませんでした。

これが私のローカルdocs/sourceディレクトリです：

conf.py次のディレクティブが含まれています。

次のコマンドを使用して API ドキュメントを作成しました。

何が問題なのか誰にもわかりますか？

autodoc拡張子を持つ Sphinx を使用して、Python パッケージのドキュメントを自動生成しています。私が直面している問題はautodoc、アンダースコアのあるモジュールをスキップすることです。

一部のモジュールは、ユーザーがインポートするのを思いとどまらせるためにアンダースコアが付けられました。ただし、これらの下線付きファイル内のクラスには下線がありません。

下線付きのモジュールを手動でに追加してpackage_name.rst実行するとmake html、表示されます。だから私の問題は、それをから自動化する方法autodocです。

package_name.rstそれらを追加するためにスクリプトを介して解析することを避けようとしています。autodoc フラグまたはハックを期待しています!

プロジェクトのドキュメントを作成するために sphinx を使用しようとしています。これは、プロジェクト内のモジュールに分割された一連の関数です。

ドキュメントで公開する関数の小さなサブセットのみが必要なので、ドキュメントautodoc-skip-member文字列にタグを付けて不要なものを除外していましたが、不要な関数をリストしないことで機能しているように見えますが、空のモジュールの束になってしまいますおよびサブモジュール。

空のモジュールをリストしないようにスフィンクスに指示する方法はありますか? この機能を使用できると思いますexcludeが、新しいコードを追加するプロセスが自動化されないため、常に除外リストを維持する必要があります。

このフローを使用して HTML ドキュメントを生成しています。

これは、最終的な HTML ドキュメントにリストされているモジュールでconf.py返される場合でも、ファイル内の関数を除外するコードです。True