repoze.sphinx.autointerfaceはスフィンクスのドキュメントシステムのための拡張機能を定義します 拡張子は、コードでzope.interfaceインスタンスのイントロスペクションによってAPIドキュメントを生成することができる。
のインストール:の
easy_installを経由してインストールします。
ビン/ easy_installをrepoze.sphinx.autointerface
あなたのPYTHONPATH上のパッケージを取得するか、他の手段。
の拡張を登録するの
お使いの製品のスフィンクスのドキュメントのconf.pyのextensionsリストにrepoze.sphinx.autointerfaceを追加します。例えば:
拡張子= ['sphinx.ext.autodoc」、
  'sphinx.ext.doctest」、
  'repoze.sphinx.autointerface」、
 ]
の拡張を使用して、の
文書内の適切な時点で、インタフェースautodocsを介して呼び出します。
.. autointerface :: yourpackage.interfaces.IFoo
指令からの出力は含まれて
  *完全修飾インタフェース名
  *すべてのベースのインターフェイス
  * reSTXとしてレンダリングインターフェイス、からdoctstring。
  *インタフェース(メソッドと属性)のメンバー。
 それぞれの属性Oの、出力は、属性名とその説明が含まれています。
 それぞれの方法については、出力はメソッド名、その署名、および(またreSTXとしてレンダリング)のドキュメンテーション文字列が含まれます。o
のこのリリースのの新機能:。
- PyPyは互換ます。
- のPython 3.2+の互換性。パッチのArfreverに感謝します。
- いるautomoduleディレクティブの下インターフェースのドキュメントを含めます。パッチのKrysローレンスに感謝します。
のバージョン0.6.2でのの新機能:
- 修正はTypeError: 'NoneType'オブジェクトが反復可能ではないエラーのPython 2.7の下でインターフェイスのレンダリングを生成するときにします。
のバージョン0.6.1でのの新機能:
- 修正取り扱い ':メンバー注文bysource」ます。
のバージョン0.6のの新機能は次のとおりです。
- は正しく処理 ':メンバー:'明示的に設定された値指令します。
のバージョン0.5の新しいのは何ですか。
- のサポートが追加されました ':メンバー-順:'フラグ、これは3株式価値の1、&QUOTを取ることができます。アルファベット順&QUOT ;,&QUOT、GroupWiseの&QUOT ;,または&QUOT、bysource&QUOT ;.ハッシュ"デフォルトでは、メンバーがQUOT&に記載されています。オーダーます。
の要件の
- のPythonます。
- スフィンクスます。
コメントが見つかりません