跳转到主要内容

为Zope 3提供的API文档和组件检查

项目描述

Documentation Status Build Status Code Coverage

这个Zope 3包提供了Zope 3和注册的附加组件的完全动态API文档。该包非常易于扩展,可以通过实现新模块轻松扩展。

文档可在https://zopeappapidoc.readthedocs.io/找到

变更

5.0 (2023-07-06)

  • 删除对Python 2.7、3.5、3.6的支持。

  • 添加对Python 3.11的支持。

4.3.0 (2021-12-15)

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

  • 删除对Python 3.4的支持。

4.2.0 (2018-08-21)

  • 添加对Python 3.7的支持。

  • 代码文档节点不再允许意外遍历和文档化未注册的根模块,如reloggingbuiltins是特殊案例)。这些内容未列入目录或菜单,并且主要起到降低静态导出速度的作用。若要文档化根模块,请显式地在ZCML中包含它,使用<apidoc:rootModule module="MODULE" />。请参阅问题 #20

  • 修复具有 __file__None 的模块的 codemodule.Module。这可能是命名空间包的情况,尤其是在 Python 3.7 下。参见 问题 #17

  • 对于具有 __doc__ 属性的类生成文档不再失败,而是生成描述性消息。参见 问题 16

  • https://zopeappapidoc.readthedocs.io/ 上托管文档。

  • static-apidoc 添加参数以加载特定的 ZCML 文件。要使用此功能,您指定的 ZCML 文件需要设置一个可用的 Zope 3 发布环境。这样做最简单的方法是在 ZCML 中包含此行: <include package='zope.app.apidoc' file='static.zcml' condition='have static-apidoc' />。参见 PR #13

  • 在实时 apidoc 中的类查找条目现在单独显示,就像在静态导出中一样。参见 PR #14

  • 静态导出中的类查找搜索将在按下“Enter”时进行,而不仅仅是在点击“查找”时。参见 PR #15

  • __main__.py 文件不再被代码文档模块导入。参见 问题 #22

  • 在 Python 2 上注册为适配器的 Cython 函数不再因 AttributeError 而破坏页面生成。参见 问题 25

  • 静态导出不再突出显示 ZCML 文件中的行。参见 问题 #24

4.0.0 (2017-05-25)

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

  • 长期废弃的层配置已被删除。它仅在安装了 deprecatedlayers ZCML 功能时才可用。

  • 改进了一些模板。现在可以通过 z3c.pt 和 z3c.ptcompat 使用 Chameleon 3.2 来使用 zope.app.apidoc

  • zope.app.exception 上声明安装依赖。

  • 在 Python 2 上将文档字符串视为 UTF-8。

  • 在 Python 3 的函数签名中处理关键字仅参数和注释。

  • 对于未指定 __docformat__ 的模块,将默认文档格式更改为 restructuredtext。以前它是 structuredtext (STX)。

3.7.5 (2010-09-12)

  • 在 doctests 中定义 __file__ 以使其在 Python 2.4 下通过。

3.7.4 (2010-09-01)

  • 优先使用标准库的 doctest 模块而不是 zope.testing 中的模块。

  • 删除不需要的依赖项 zope.app.component 和 zope.app.container。

3.7.3 (2010-07-14)

  • 应用 #153309 的重构。

  • 修复 LP 错误 605057:ZCML 链接不再工作(Guilherme Salgado)

3.7.2 (2010-03-07)

  • 调整测试以适应 Python2.4。

3.7.1 (2010-01-05)

  • 更新测试以与 zope.publisher 3.12 兼容(使用 zope.login)。

3.7.0 (2009-12-22)

  • 更新测试以与最新的 zope.testing 兼容,并使用 zope.browserpage 而不是 zope.app.pagetemplate

3.6.8 (2009-11-18)

  • 在将 IPossibleSiteISite 移动到 zope.component 后更新测试。

3.6.7 (2009-09-29)

  • ITraverser 返回到 zope.traversing 后更新测试。

3.6.6 (2009-09-15)

  • 使测试与最新的 Zope Toolkit KGS 一起工作。

3.6.5 (2009-07-24)

  • 更新 zope.site 中的文档文件,从 README.txt 更新到 site.txt

3.6.4 (2009-07-23)

  • IContained 接口移动到 zope.location.interfaces。使测试通过。

3.6.3 (2009-05-16)

  • 明确定义默认视图。

  • 用绝对链接替换相对链接。

  • z3c 包添加到代码浏览器。

  • 使 bin/static-apidoc 主要功能正常(发布者和网络服务器模式)。仍然有一些文件无法正确获取。

3.6.2 (2009-03-17)

  • 将主要注册簿章节适应新位置,因为它已从 zope.app.security 移至 zope.principalregistry。

  • 移除 zcml 链接和旧 zpkg 相关文件。

3.6.1 (2009-02-04)

  • 当模块提供接口或具有 __all__ 属性时,请在模块文档中使用其中之一。修复 LP #323375。

  • 撤销了 3.6.0 中导致的 savepoint.txt 破坏链接。事务包的最新版本将 savepoint.txt 放在 tests 子包中。

  • 扩展了模块文档的展示。

  • 类文档现在包括构造函数信息。

3.6.0 (2009-01-31)

  • 使用 zope.container 而不是 zope.app.container。

  • 使用 zope.site 而不是 zope.app.component 和 zope.app.folder(至少在某些地方)。

  • savepoint.txt 已从 ZODB 的测试目录上移至更高一级——我们遵循。

  • 使其与新 zope.traversing 和 zope.location 兼容。

3.5.0 (2009-01-17)

  • 为新的事务 egg 适应事务书章节。已删除 README.txt,并将 savepoint.txt 移动。还添加了关于毁灭性事务(doom.txt)的章节。

  • 将邮件列表地址更改为 zope-dev@zope.org,因为 zope3-dev 已弃用。

  • 清理了依赖关系。

3.4.3 (2007-11-10)

3.4.2 (2007-10-30)

  • 避免 ZopeMessageFactory 的弃用警告。

3.4.1 (2007-10-23)

  • 避免弃用警告。

3.4.0 (2007-10-10)

  • 改进了包元数据。

  • 修复了代码,至少可以优雅地忽略未解压的 eggs。最终我们希望很好地处理 eggs。

3.4.0a1(2007-04-22)

  • 首次独立于主 Zope 树发布。

下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

zope.app.apidoc-5.0.tar.gz (140.5 kB 查看哈希值)

上传时间

构建分发

zope.app.apidoc-5.0-py3-none-any.whl (195.4 kB 查看哈希值)

上传时间 Python 3

支持