Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Spinx support for ZConfig

Project Description

For more information on ZConfig, see:

Initially (and probably permanently :) ) This consists of a zconfigsectionkeys directive for rendering documentation for ZConfig section keys.


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:



The name of the Python package containing the XML file.
The name of an XML file containing section definitions. Typically, this is cpmponent.xml.
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


0.1.0 (2016-09-07)

Initial release

Release History

Release History

This version
History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
j1m.sphinxautozconfig-0.1.0.tar.gz (2.4 kB) Copy SHA256 Checksum SHA256 Source Sep 7, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting