repoze.sphinx.autointerface 0.8

概述

这个包为 Sphinx文档系统。分机 允许通过内省 zope.interface中的实例 代码。

安装

通过easy_install安装：

$ bin/easy_install repoze.sphinx.autointerface

或者任何其他方法来获取PYTHONPATH上的包。

注册扩展名

将repoze.sphinx.autointerface添加到 conf.py您产品的sphinx文档。例如：

extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.doctest',
              'repoze.sphinx.autointerface',
             ]

使用扩展名

在文档中的适当位置，调用接口 自动文档通过：

.. autointerface:: yourpackage.interfaces.IFoo

指令的输出包括

• 完全限定的接口名称
• 任何基本接口
• 接口中的doctstring，呈现为restx。
• 接口的成员（方法和属性）。
  • 对于每个属性，输出包括属性名 以及它的描述。
  • 对于每个方法，输出包括方法名、它的签名， 以及它的docstring（也呈现为restx）。

0.8（2016-03-28）

• 添加对Python3.3、3.4和3.5的支持。
• 放弃对Python2.6和3.2的支持。
• 允许使用:class:指令的交叉引用使用 .用于“模糊”搜索。感谢杰森·马登的修补。

0.7.1（2012-09-15）

• 删除setup.py对ez_setup.py的依赖关系。

0.7.0（2012-06-20）

• pypy兼容性。
• python 3.2+兼容性。多亏了阿弗雷弗的修补。
• 在automodule指令下包含接口文档。多亏了 克雷斯劳伦斯的补丁。

0.6.2（2011-02-13）

• 修复生成时的TypeError: 'NoneType' object is not iterable错误 python 2.7下的接口呈现。

0.6.1（2011-01-28）

• 修正：成员顺序：bysource“处理。

0.6（2011-01-28）

• 正确处理“：members:”在指令中显式设置的值。

0.5（2011-01-18）

• 添加了对“：member order:”标志的支持，该标志可以接受 “按字母顺序”、“按组”或“按源”三个股票值。由 默认情况下，成员以“散列”顺序记录。

0.4（2010-07-26）

• 固定与Sphinx 1.0的兼容性
• 再次取消中断pypi rest/html呈现。

0.3（2009-10-25）

• 重构sphinx集成。现在有单独的autointerface 以及interface指令。

0.2.1（2009-08-20）

• 修复add_指令参数以使用sphinx 0.6.1，现在是必需的。

0.1.3（2009-01-14）

• 在_resolve_dotted_name中将unicode路径元素强制为str。 注意，非ascii路径元素不起作用：此修复只处理 在路径类型为Unicode的情况下。
• 修正了readme.txt中指令的拼写错误。
• 添加了对zope.interface的依赖关系。

0.1.2（2008-10-03）

• 打包更改：在readme.txt中改进了描述。

0.1.1（2008-10-03）

• 打包错误：无法将long_description正确呈现给 pypi上的html。

0.1（2008-10-02）

• 初次发布。