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 details)

Uploaded Source

File details

Details for the file sphinxcontrib-proceduralimage-0.2.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-proceduralimage-0.2.tar.gz
Algorithm Hash digest
SHA256 da5c4063494767bccdd4a0c5e3aef9d2ca56962518ecd503ae1d555032f5d597
MD5 a097b555bac0d9c9cbfee00e9bc6ee3c
BLAKE2b-256 2079dbd528a9d9052c43d7e56ff0d747d4da8894cc0b3bd5c9e57b44ee55433d

See more details on using hashes here.

Supported by

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