Spinx support for ZConfig
Project description
For more information on ZConfig, see: https://pypi-hypernode.com/pypi/ZConfig
Initially (and probably permanently :) ) This consists of a zconfigsectionkeys directive for rendering documentation for ZConfig section keys.
Usage
Install the j1m.sphinxautozconfig package.
Include 'j1m.sphinxautozconfig' in the list of extensions in your sphinx configuration:
extensions = ['j1m.sphinxautozconfig']
Where you want the documentation for the keys of a ZConfig section, use the zconfigsectionkeys directive:
.. zconfigsectionkeys:: PACKAGE_NAME XML_FILE_NAME SECTION_NAME
where:
- PACKAGE_NAME
The name of the Python package containing the XML file.
- XML_FILE_NAME
The name of an XML file containing section definitions. Typically, this is cpmponent.xml.
- SECTION_NAME
The name of the section to render documentation for.
For example, to render key documentation for the ZODB filestorage section:
.. zconfigsectionkeys:: ZODB component.xml filestorage
Changes
0.1.0 (2016-09-07)
Initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for j1m.sphinxautozconfig-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18632d27238e5eccad2aba2f80575a1587a30711049442782841da7934aea5c8 |
|
MD5 | c8f559904f281c8f9d00b49bcef10243 |
|
BLAKE2b-256 | 8e8a4997fb7f59be5c82495312c9749c8fed7f23a503071baa0439e0bac12629 |