dm.zdocはZopeのためのそれを使用できるようにするpydocの周りに小さなPythonラッパーです。
注:の2.6以下のPythonのバージョンはpydoc内の名前空間のパッケージのために良いサポートしていない。 Zopeは、それ自体が(Pythonの2.6を使用しています)、バージョン2.12の前に名前空間のパッケージを使用しませんが、(そのようなPloneのような)重要なZopeのアプリケーションでは、名前空間のパッケージを使用していますか。これらのケースでは、pydoc(および伸長zdocによって)によって生成ドキュメントが不完全である。
の使用法の
zdocは、モジュールのインポートを経由して、スクリプトdmzdocを経由して使用したり、実行中のZopeインスタンスに統合することができます。
最初の2例では、Zopeのソースを見つけることができる場所zdocに指示するZopeの環境変数INSTANCE_HOMEとSOFTWARE_HOMEを設定する必要があるかもしれません。
dmzdocを経由して使用してください
あなたがインストールされてsetuptoolsのを持っている場合、スクリプトdmzdocがインストールされている。
そうでなければ、それを自分でインストールする必要があります。それは、以下の内容があります。
輸入dm.zdoc。 dm.zdoc.cli()
dmzdocはpydocで文書化pydoc、とまったく同じオプションとパラメータを持っています。
モジュールのインポートを経由して使用してください
モジュールdm.zdocはpydocで文書化pydoc、同じオブジェクトを定義します。
実行中のZopeインスタンスに統合
この使用のために、あなたはあなたのZopeインストールでモジュールをインストールし、Zopeの起動時にのconfigure.zcmlをアクティブにする必要があります。これは、「Zopeのルートフォルダ "pydocのhttpサーバと同じように文書を提示ビュー@@ zdocを与えるだろう。
<強い>注意:の、このようにZopeインスタンスのドキュメントを公開するには、賢明な洞察を提供し、ハッカーの攻撃のための貴重な手がかりを与えることができる。多分、あなただけのアクセスが制限された開発インスタンスでこれをインストールします。
のこのリリースのの新機能:ます。
- のサポート&QUOT; runnging Zopeインスタンス&QUOTに統合。ユースケースます。
の要件の
- のPythonます。
コメントが見つかりません