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
1 maintainer
Metadata
1 maintainer
Release files for j1m.sphinxautozconfig 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| j1m.sphinxautozconfig-0.1.0.tar.gz | 2.4 kB | Without provenance | Details for j1m.sphinxautozconfig-0.1.0.tar.gz |
Release files / j1m.sphinxautozconfig-0.1.0.tar.gz
| Download URL | j1m.sphinxautozconfig-0.1.0.tar.gz |
|---|---|
| Size | 2.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
18632d27238e5eccad2aba2f80575a1587a30711049442782841da7934aea5c8
|
|
BLAKE2b-256 checksum How to use checksums |
8e8a4997fb7f59be5c82495312c9749c8fed7f23a503071baa0439e0bac12629
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for j1m.sphinxautozconfig 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
