web-dev-qa-db-ja.com

パッケージのすべてのPythonドキュメントをエクスポートしてDevhelpに取得するにはどうすればよいですか？

現時点では、quicklyというパッケージのドキュメントを読むために、次のようにします。

>>> import quickly
>>> help(quickly)
 
>>> import quickly.widgets
>>> help(quickly.widgets)
 
>>> import quickly.widgets.text_editor
>>> help(quickly.widgets.text_editor)

等々...

これは明らかに非常に退屈です。すべてのサブパッケージを含むすべての迅速なドキュメントをエクスポートして、devhelpドキュメントブラウザに表示するにはどうすればよいですか？

ドキュメントをHTMLとしてエクスポートするのもいいでしょう。それのあるバージョンがウェブ上に存在していたとしても私は幸せでしょうが、私はそれを見つけることができないようです。

注：packageでは alt textpython-package 、. debパッケージではありません。

programmingpythondocumentation
6
Stefano Palazzo

epydocを使用して、pythonモジュールのHTMLドキュメントを作成できます。Install epydoc 。

Epydocは、docstringに基づいてPythonモジュールのAPIドキュメントを生成するためのツールです。

epydocを使用してモジュールquickly.widgetsのHTMLドキュメントを作成する方法は次のとおりです。

epydoc --html quickly.widgets -o quickly_widgets_doc

これが完了したら、Webブラウザでquickly_widgets_doc/index.htmlを開きます。

alt text

または、PDFでこのドキュメントを希望する場合：

epydoc --pdf quickly.widgets --name "quickly.widgets" -o quickly_widgets_doc_pdf

これにより、ファイルquickly_widgets_doc_pdf/api.pdfが作成されます

alt text

epydochere の使用に関する詳細情報。

これらをDevHelpで使用できる形式に変換する方法を見つけられませんでしたが、この答えを編集します。

6
Isaiah

ほとんど知られていない「秘密」は、すべてのPythonインストールに含まれている pydocツール です（したがって、追加のパッケージをインストールする必要はありません）。

http：// localhost：8000 / をリッスンするソースからインスタントドキュメントを生成するWebサーバーを起動します（Pythonコンソールのhelp()と同じ手法を使用）。で：

pydoc -p 8000

Webサーバーと、検索オプションなどを提供するTkinterベースのGUIを起動します。

pydoc -g

Quick.widgetsのドキュメントを、現在のディレクトリにあるHTMLファイルquick.widgets.htmlに書き込みます。

pydoc -w quickly.widgets
4
JanC