python - Pydoc を使用してドキュメントを生成する方法

Question

pydoc を使用してコメントからドキュメントを生成する必要があります。それを行うための基本的な手順は何ですか？

Answer 1

本当に Pydoc を使用したい場合は、ターミナルで簡単に実行できます。

$ pydoc -w myproject

これにより、ドキュメントリングから昔ながらの HTML ドキュメントが生成されます。Pydoc は Python で 2.1 以降help()関数に使用されるモジュールであることに注意してください。コメントではないドキュメント文字列を取得します。docstring を使用して関数を記述する必要があります。

しかし、ドキュメントの生成に Pydoc を使用するのは一種の古い学校です。Python でこれを行うための一般的なツールはSphinxです。ただし、reStructuredText として特定の形式でドキュメント文字列をフォーマットする必要があります。

また、ドキュメント文字列 (パブリック API) からドキュメントを自動抽出し、マークダウン、numpydoc、Google スタイルのドキュメント文字列形式、およびいくつかの reStructuredText ディレクティブをサポートするpdocを使用することもできます。

docstring の書式設定に関する情報については、こちらを参照してください。

Pymentを使用して、docstring スケルトンを生成したり、既存のものを特定の形式に変換したりすることもできます。