Socket
Socket
Sign inDemoInstall

j1m.sphinxautozconfig

Package Overview
Dependencies
0
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    j1m.sphinxautozconfig

Spinx support for ZConfig


Maintainers
1

Readme


Spinx support for ZConfig


For more information on ZConfig, see: https://pypi.python.org/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

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc