https://github.com/timo/sphinxcontrib-proceduralimage
embed pictures generated from python code into your sphinx documentation
https://github.com/timo/sphinxcontrib-proceduralimage
Last synced: about 1 year ago
JSON representation
embed pictures generated from python code into your sphinx documentation
- Host: GitHub
- URL: https://github.com/timo/sphinxcontrib-proceduralimage
- Owner: timo
- Created: 2011-09-22T21:19:44.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2011-09-22T23:34:06.000Z (over 14 years ago)
- Last Synced: 2025-04-10T01:17:29.533Z (about 1 year ago)
- Language: Python
- Homepage: http://wakelift.de/posts/proceduralimage/
- Size: 93.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
Awesome Lists containing this project
README
This package adds the proceduralimage directive to Sphinx_.
.. _Sphinx: http://sphinx.pocoo.org/
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.