2013-01-02 14 views
9

可能性の重複:
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: 
+0

あなたは既に['autodoc'拡張子](http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc)をチェックしましたか? –

+0

autodoc拡張がconf.py: に追加されましたextensions = ['sphinx.ext.autodoc'、 'sphinx.ext.viewcode'] Sphinxはすべてのモジュールを検出しますが、クラスとそのメソッドはリストしません。 – Jon

+0

上記のautodocの拡張によると、あなたがundoc-membersフラグオプション ' – intotecho

答えて

1

この中にあなたを助けるスフィンクス拡張子があります。

拡張子はautodocです。

クラスを含めたい場合、あなたは、メソッドのため

.. autoclass:: <ClassName> 

Sllyを記述する必要があります。

+7

私はautodocを使用しない限り、docstringsのないメンバーは除外されます。これは、私が何千もの時間を..autoclassを追加したり、スクリプトを作成しなければならないことを意味します。自動検出はありませんか? – Jon

+2

あなたは 'automodule'を使うことができます自動的にメンバーを文書化したい場合、メンバーオプションがあります。リンクを確認してください。 autodoc拡張には多くのオプションがあります。 – Nilesh

関連する問題