python - Python用のドキュメントツールはありますか?

Question

perl の場合は perldoc、c の場合は man のように。

Python用のものはありますか？

Answer 1

通常、ドキュメント文字列を使用する必要があります。

def foo(bar):
   """ Applies the foo operation onto bar """
   # ...

次に、 pydocまたはsphinxを使用してHTML (またはその他の出力形式) を生成するか、組み込みhelp関数を使用してライブ オブジェクトでそれらを表示できます。

組み込みモジュールのドキュメントは、オンライン(ダウンロードも可能) または経由で入手できますhelp。

Answer 2

あります-それは「pydoc」と呼ばれます。たとえば、シェルから実行できます。

$ pydoc sys

sys モジュールに関するヘルプが表示されます。簡単な GUI 管理で、ヘルプを html (pydoc -w) または spawn サーバーにエクスポートできます。

$ pydoc -g

Answer 3

Python シェルでは、help組み込み関数を使用できます (たとえば、os.path モジュールのドキュメントは次のとおりです)。

>>> import os
>>> help(os.path)

モジュール posixpath に関するヘルプ:

名前 posixpath - Posix パス名に対する一般的な操作。

ファイル /usr/lib/python2.7/posixpath.py

モジュール ドキュメント http://docs.python.org/library/posixpath

説明 このモジュールを直接インポートする代わりに、os をインポートして、このモジュールを os.path として参照します。「os.path」という名前は、Posix システムでのこのモジュールのエイリアスです。他のシステム (Mac、Windows など) では、os.path はそのプラットフォームに固有の方法で同じ操作を提供し、別のモジュール (macpath、ntpath など) へのエイリアスです。

Some of this can actually be useful on non-Posix systems too, e.g.
for manipulation of the pathname component of URLs.

機能

... ... ..