repoze.sphinx.autointerface定义了狮身人面像的文件系统的扩展与NBSP;扩展允许生成API文档在代码zope.interface实例的自省。
安装:
通过easy_install的安装:
斌/ easy_install的repoze.sphinx.autointerface
或任何其它装置,它获取包上的PYTHONPATH。
注册扩展
添加repoze.sphinx.autointerface的扩展名列表中狮身人面像文档为您的产品的conf.py。例如:
扩展= ['sphinx.ext.autodoc',
 “sphinx.ext.doctest',
 “repoze.sphinx.autointerface',
 ]
使用扩展
在你的文档中的适当位置,调出界面autodocs通过:
.. autointerface :: yourpackage.interfaces.IFoo
从指令输出包括
  *完全限定接口名称
  *任何基本接口
  *从界面,呈现为reSTX的doctstring。
  *接口的成员(方法和属性)。
  o对于每个属性,输出包括属性名称和描述。
  o对于每种方法,输出包括方法的名字,它的签名,其文档字符串(也译作reSTX)
什么是新的在此版本中:
- 在PyPy兼容性。
- 在Python的3.2+的兼容性。由于Arfrever的补丁。
- 在包括根据automodule指令接口文档。由于Krys劳伦斯的补丁。
什么是0.6.2版本,新的:
- 在修复类型错误:'NoneType'对象不是可迭代错误的Python 2.7下生成界面渲染的时候。
什么在0.6.1版本新:
- 在修正“:成员阶:bysource”处理。
什么是0.6版本,新的:
- 在正确处理“:成员:”价值观在明确设置指令。
什么版本0.5是新的:
- 在增加了支持“:成员阶:'标志,这可能需要一个三大股票价值,与QUOT;字母"," GroupWise的"或" bysource&QUOT ;.默认情况下,大家都记录在"散"令。
要求:
- 在Python中
- 在狮身人面像
评论没有发现