問題タブ [pydoc]

コマンドラインから pydoc を使用する方法を知っています。ただし、環境設定が複雑なため、Python スクリプト内でネイティブ API 呼び出しとして実行することをお勧めします。つまり、私の python ランナーは次のようになります。

import pydoc pydoc.generate_html_docs_for(someFile)

ただし、この動作を機能させるためにどの関数呼び出しを使用する必要があるかは、pydoc のドキュメントからはわかりません。何か案は？

一連のWikiスタイルページを生成できるPyDocのようなものと、PyDocからエクスポートする現在のHTMLページを探しています。現在のドキュメントの拡張機能として、これらをGoogleCodeのWikiにエクスポートできるようにしたいと思います。

pydocのwritedocs（）関数を取得してパッケージのサブディレクトリを作成する方法はありますか？たとえば、次のモジュールを文書化するとします。

pydoc.writedocs（）を実行すると、次のファイルが表示されます。

取得したい：

これを行う方法はありますか？

多くの呼び出し可能なオブジェクトがあり、それらはすべて__doc__文字列が正しく入力されていますが、ヘルプを実行すると、に基づくヘルプではなく、クラスのヘルプが生成され__doc__ます。

ヘルプを実行すると、 を実装するクラスのインスタンスではなく、実際の関数である場合に得られるものと本質的に同じように見えるカスタマイズされたヘルプが生成されるように変更したいと考えています__call__。

コードでは、これを出力したいと思います：

次の出力のようになります。

object.__doc__ソースコードでドクトリング自体の前に「r」を追加する以外に、生の文字列として取得する方法はありますか？

内部にラテックスコードがあり、「\ r」、「\f」などが問題を引き起こしています。

Windowsおよびpython.org2.6.4でpydocを使用しようとすると、次のエラーが発生します。

ここで何が間違っている可能性がありますか？

最近IMDbpyモジュールをダウンロードしました。ダウンロードすると、

私は完全なドキュメントを取得しません..私はしなければなりません

利用可能なメソッドを確認します。私はこのコンソールインターフェースが好きではありません。ドキュメントを読むためのより良い方法はありますか？モジュールimdbに関連するすべてのドキュメントを1ページにまとめたものです。。

現在、既存の (不完全な) ドキュメントをすべてSphinxに移行しています。

問題は、ドキュメンテーションがPython docstringを使用しており(モジュールは C で書かれていますが、おそらく問題にはなりません)、クラスのドキュメンテーションを Sphinx で使用できる形式に変換する必要があることです。

sphinx.ext.autodocがありますが、現在のドキュメント文字列をドキュメントに自動的に配置します。現在のdocstringに基づいて（ RST ）でソースファイルを生成したいので、手動で編集および改善できます。

docstring を Sphinx の RST に変換するにはどうすればよいですか?

特定のクラスから継承するクラスを宣言する場合：

クラスのドキュメントには、 （〜または）Cのすべてのメソッドがリストされています。dicthelp(C)pydoc

自動生成されたドキュメントから継承されたメソッドを非表示にする方法はありますか（上書きされないメソッドの場合、ドキュメント文字列は基本クラスを参照できます）？またはそれは不可能ですか？

これは便利です：モジュールのクラスの後pydocにモジュールで定義された関数をリストします。したがって、クラスに非常に長いドキュメントがある場合、モジュールによって提供される新しい関数が提示される前に、有用ではない多くの情報が出力され、ドキュメントの悪用が困難になります（継承されたメソッドのすべてのドキュメントをスキップする必要があります）文書化されているモジュールに固有の何かに到達するまで）。

math一部のPythonモジュール（およびなど）のpydocドキュメントには、sysいくつかのHTMLドキュメントへの便利なリンクを含む「MODULEDOCS」セクションがあります。

そのようなセクションを自分のモジュールにどのように含めることができますか？

より一般的には、pydocによって認識される変数が文書化されている場所はありますか？

mathモジュールは私のマシン（OS X）上の共有ライブラリであり、モジュールはPythonで構築されているため、ソースでこれを見つけることができませんでしたsys…何か助けていただければ幸いです。