2012-04-12 8 views
0

パッチを適用した後もEpydocはうまく機能しないので、私はSphinxに移行しようとしています。私は、単純なPythonのファイルからドキュメントを自動生成したいepydocからsphinxに移動してシンプルなpython .pyファイルを自動文書化

test.py

スフィンクス・クイックスタート・スクリプトをインストールして実行した後、私はソースフォルダにtest.pyをコピーそして、入力された:

スフィンクスビルド-b htmlの\ソース\

012を構築する。。は、

しかし、それだけでminimiun HTMLファイルを生成し、それは私がアイデアを使い果たしていtest.pyファイル

を解析しません。あなたの助けのための

感謝:)

+0

あなたの質問に答えるかどうか分からない場合は、回答にコメントを追加できます。 – bmu

答えて

1

あなたは.. autoclass::と、このモジュールから.. automodule::ディレクティブ(またはオブジェクトを使用して、モジュールを文書化することができるよりも、あなたのconf.pyhttp://sphinx.pocoo.org/config.html#confval-extensions)での拡張機能としてsphinx.ext.autodocを含める必要があり、.. autofunction::、 ...)。

は、あなたがsphinx-apidocを使用することができ、自動生成に必要な.rstファイルをするために

+0

申し訳ありませんが、私はこのページが私の電子メールに気づくと思っていたので、私はあなたの答えを今まで見ていませんでした。ありがとう! – chelder

1

http://sphinx.pocoo.org/ext/autodoc.htmlを参照してください。

これは、人生をはるかに簡単にします。だからあなたはそれぞれのモジュールを手動で文書化する必要はありません。

+0

感謝の男!私は将来Phythonで何かを作成する場合、私はそれを試してみます:) – chelder