問題タブ [pydoc]

私はdjango python 1.7および2.7で作業しています。内部に単一のアプリケーション（「SIGAPPY」）を含むプロジェクト（「TEJUJAGUA」）があります。アプリケーションは使用時に正しく実行されます。私の問題は、pydocでドキュメントを生成する必要があることです。

これを行うには、manage.py ファイルがあるディレクトリにあるシェルから、次のコマンドを実行します。

次の出力が生成されます。

その結果、pydocは一部のファイルに対してのみ html ページを生成しますが、FirstView.py、forms.py などの他のファイルは省略します。

このエラーの理由について何か考えはありますか?

他のコード セグメントが必要な場合に備えて、私は警戒しています。

@authorjavadoc では、@return、などのタグを使用できます@deprecated。これらは、Java ドキュメントを作成するときに特別に処理されます。pydoc に同等の機能がありますか、それともメソッドの docstring の逐語的なコピーに限定されていますか?

perldocの概要:

Perl モジュールを作成するときは、PODスタイル ドキュメントで文書化できます。次に、モジュールの動作の概要を取得するには、コマンド ラインに次のように入力します。

perldoc <module_name>

Pythonでこれを行うにはどうすればよいですか?

Python には、Perl の POD スタイルにいくぶん似た「docstring」を使用してコードを文書化する標準形式があることを理解しています。help()関数を使用して Python モジュールに関する情報を抽出できますが、これはエレガントとは言えません。

最初に Python インタープリターを開始する必要があります。次に、ヘルプを取得したいモジュールをインポートします。最後に、help()関数を使用してモジュールに関する情報を取得できます。

例：

より良い方法はありますか？

これがPerlで機能する方法と同等のPythonが欲しいです：

pydoc <module_name>

しかし、これを試すと、次の出力が得られます。

外部サーバーにドキュメントを置きたいプロジェクトがあります。私はpydoc -p 5000私が私のドキュメントを持っていることを知っていますhttp://localhost:5000/。ただし、誰もがアクセスできる外部サーバーとして、EC2 インスタンスでそのドキュメントをホストすることを計画しています。10.10.10.10マシンの IP アドレスが であり、外部からアクセスできるように完全に構​​成可能であるとしましょう。pydocサーバーを外部で実行するにはどうすればよいですか?

「Windows 7 - cmd からの pydoc」に続いて、次の問題があります。docstring で文書化された単純な hello.py "hello world" スクリプトを用意しました。

C:\Python34\lib に保存します。

次に、Windows のコマンドラインを使用して、ディレクトリを C:\Python34\lib に変更し、実行しました。

私の出力は次のとおりです。

ドキュメントを印刷したことは素晴らしいことですが、最初にプログラムを実行しました。

プログラムを実行せずにドキュメントを印刷するにはどうすればよいですか?

マンページを作成したい python スクリプトのセットがあります。それらはドキュメント文字列で文書化されているので、その方法でドキュメントを取得できますが、マンページも必要です。

マンページの *roff ソースを生成するために pydoc を使用する方法はありますか?

編集: Python 用の perl の pod2man のようなもの。