29

Python 用のドキュメンテーション ツールはたくさんあるようです。私が遭遇した別のものはepydocです。Sphinx は、公式の Python ドキュメントを生成するために使用されているため、デファクト スタンダードのようです。誰かが私のために Python のドキュメンテーション ツールの現在の状態を整理してくれませんか?

4

3 に答える 3

26

epydocSphinxは異なる種類のツールです。

それらは次の点で同じです。

  • どちらもdocutils経由でReSTを使用します。
  • どちらも焦点が非常にPythonicです
  • どちらも HTML および PDF ドキュメントを生成できます

それらは焦点が異なります。

  • Epydoc は、API (開発者) のドキュメントに重点を置いています。Epydoc を使用すると、より多くの結果をより迅速に得ることができます。ソースコードにそれを向けると、何かが得られます。これは、私が API ドキュメンテーション ツールに求めるものです。
  • Sphinx は、一般的な (ユーザー) ドキュメントに焦点を当てています。Sphinx はソース コードから多くの情報を取得しますが、もう少し情報を追加する必要があります。Sphinx は API ドキュメントを生成できますが、それは単純ではなく、IMO は Epydoc ほどうまく機能しません。Sphinx がPythonに選択されているため、同意しない人もいると思います。しかし、それはあなたがそれにどれだけの仕事をしたいかによって異なります. 私は、一般的なドキュメント用の Sphinx が大好きです。

したがって、どれだけの作業を行い、何を文書化するかによって異なります。

于 2010-03-14T04:15:48.010 に答える
2

Epydocは、死んでいないにしても、少なくともフィヨルドを狙っているようです。

sphinx-apidocコマンドとautodoc拡張機能を備えた Sphinx は、現時点で API ドキュメントの最も一般的なオプションのようです。

良い例は次のとおりです。

参照: Python API のドキュメント化には、Epydoc、Sphinx、または他のものを使用する必要がありますか? (SO5579198)

Sphinx は javadoc 型のツールよりも物語的なスタイルを奨励していますが、これは良いことでしょうか?

于 2013-05-08T18:28:52.933 に答える