repoze.sphinx.autointerface 1.0.0

概述

该包为Sphinx文档系统定义了一个扩展。该扩展允许通过代码中zope.interface实例的反射来生成API文档。

安装

使用pip安装

pip install repoze.sphinx.autointerface

注册扩展

将repoze.sphinx.autointerface添加到您产品的Sphinx文档的conf.py文件中的extensions列表中。

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

使用扩展

在文档的适当位置调用自动文档接口。

.. autointerface:: yourpackage.interfaces.IFoo

指令输出的内容包含

• 完全限定的接口名称

• 任何基接口

• 接口的文档字符串，以reStructuredText格式呈现

• 接口的成员（方法和属性）

  • 对于每个属性，输出包括属性名称及其描述。

  • 对于每个方法，输出包括方法名称、其签名和其文档字符串（也以reStructuredText格式呈现）。

1.0.0 (2022-05-26)

• 移除sphinx.util.force_decode。之前我们修改它以支持Python 2和Sphinx 3.x，但Sphinx 4.0已弃用它并停止对Python 2的支持。

• 用GitHub Actions替换Travis-CI

• 添加对Python 3.6、3.7、3.8、3.9、3.10和PyPy3的支持。

• 停止对Python 2.7、3.3、3.4、3.5和PyPy的支持。

• 更新以与新版本的Sphinx兼容

  • Sphinx.domains -> Sphinx.registry.domains

  • Sphinx.override_domain(D) -> Sphinx.add_domain(D, override=True)

• 停止对Sphinx < 4.0的支持。

0.8 (2016-03-28)

• 添加对Python 3.3、3.4和3.5的支持。

• 停止对Python 2.6和3.2的支持。

• 允许使用:class:指令进行交叉引用时使用.进行“模糊”搜索。感谢Jason Madden提供的补丁。

0.7.1 (2012-09-15)

• 移除setup.py对ez_setup.py的依赖。

0.7.0 (2012-06-20)

• PyPy兼容性。

• Python 3.2+兼容性。感谢Arfrever提供的补丁。

• 在automodule指令下包含接口文档。感谢Krys Lawrence提供的补丁。

0.6.2 (2011-02-13)

• 修复在Python 2.7下生成接口渲染时出现的TypeError: 'NoneType' object is not iterable错误。

0.6.1 (2011-01-28)

• 修复处理:member-order: bysource的方式。

0.6 (2011-01-28)

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

0.5 (2011-01-18)

• 添加了对:member-order:标志的支持，它可以是三个标准值之一，“alphabetical”、“groupwise”或“bysource”。默认情况下，成员以“hash”顺序记录。

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)

• 修复添加指令的参数以与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)

• 打包错误：在PyPI上，long_description未正确渲染为HTML。

0.1 (2008-10-02)

• 初始发布。