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的哈希
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 18632d27238e5eccad2aba2f80575a1587a30711049442782841da7934aea5c8 |
|
MD5 | c8f559904f281c8f9d00b49bcef10243 |
|
BLAKE2b-256 | 8e8a4997fb7f59be5c82495312c9749c8fed7f23a503071baa0439e0bac12629 |