跳转到主要内容

Spinx支持ZConfig

项目描述

有关ZConfig的更多信息,请参阅:https://pypi.python.org/pypi/ZConfig

最初(可能永远如此 :) )这包括一个zconfigsectionkeys指令,用于渲染ZConfig部分键的文档。

用法

安装j1m.sphinxautozconfig包。

在您的sphinx配置中包含'j1m.sphinxautozconfig'到扩展列表中

extensions = ['j1m.sphinxautozconfig']

在您想要渲染ZConfig部分键的文档的地方使用zconfigsectionkeys指令

.. zconfigsectionkeys:: PACKAGE_NAME XML_FILE_NAME SECTION_NAME

其中

PACKAGE_NAME

包含XML文件的Python包的名称。

XML_FILE_NAME

包含部分定义的XML文件名称。通常,这是cpmponent.xml

SECTION_NAME

要渲染文档的部分名称。

例如,要渲染ZODB文件存储部分的键文档

.. zconfigsectionkeys:: ZODB component.xml filestorage

更改

0.1.0 (2016-09-07)

初始发布

项目详情


下载文件

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

源分发

j1m.sphinxautozconfig-0.1.0.tar.gz (2.4 kB 查看哈希)

上传时间:

由以下支持