Skip to main content

Sphinx extension for documenting zope.interface interfaces

Project description

This package contains a fork of the zopeext Sphinx extension.

Original documentation: http://packages.python.org/sphinxcontrib-zopeext

Install with pip install j1m.sphinxautointerface.

To use this extension, include ‘j1m.sphinxautointerface’ in your extensions list in the conf.py file for your documentation.

This provides some support for Zope interfaces by providing an autointerface directive that acts like autoclass except uses the Zope interface methods for attribute and method lookup (the interface mechanism hides the attributes and method so the usual autoclass directive fails.) Interfaces are intended to be very different beasts than regular python classes, and as a result require customized access to documentation, signatures etc.

Project details


Download files

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

Files for j1m.sphinxautointerface, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size j1m.sphinxautointerface-0.3.0.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page