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.

Acknowledgements

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

Project details


Release history Release notifications | RSS feed

This version

0.2

Download files

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

Source Distribution

sphinxcontrib-proceduralimage-0.2.tar.gz (3.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page