Skip to main content

proceduralimage Sphinx extension

Project description

This package adds the proceduralimage directive to Sphinx.

It allows a python code snippet to be supplied, that generates an image, that will be included in the documentation.

It adds a single directive, proceduralimage. It takes a block of python code, executes the code and extracts the local variables image_data and alt. image_data will be saved to a .png in _images and embedded and the alt variable will be used as the images alt tag.


The code is based almost entirely on sphinx.ext.graphviz.

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Files for sphinxcontrib-proceduralimage, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-proceduralimage-0.2.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

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