可能性の重複:
Sphinx — combining automodule and autoclassPython:Sphinx:すべてのクラス、メソッド、関数を自動的にスフィンクスのドキュメントに含めるには?
私はスフィンクスを使用して、数千のクラスを含むプロジェクト用のHTMLドキュメントを作成しようと、それはautodocのプラグインです。 sphinx-apidocは素晴らしい最初のファイルを作成しますが、オートクローズとの自動作成が欠けています。自動作成方法
ドキュメントにすべての変数、関数、クラス、およびデコレータを自動インクルードする方法/コマンド/ユーティリティがsphinxにありますか?
1 RSTファイルのいくつかのサンプルコード:
tagger Package
=================
:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
:members:
:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
:members:
あなたは既に['autodoc'拡張子](http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc)をチェックしましたか? –
autodoc拡張がconf.py: に追加されましたextensions = ['sphinx.ext.autodoc'、 'sphinx.ext.viewcode'] Sphinxはすべてのモジュールを検出しますが、クラスとそのメソッドはリストしません。 – Jon
上記のautodocの拡張によると、あなたがundoc-membersフラグオプション ' – intotecho