This Sphinx 1.0 extension executes programs during the build step and includes their screenshot into the documentation. GUI version of the sphinxcontrib.programoutput extension.
home: https://github.com/ponty/sphinxcontrib-programscreenshot
documentation: http://ponty.github.com/sphinxcontrib-programscreenshot
Basic usage
.. program-screenshot:: xmessage hello
:prompt:
How it works
start Xvfb headless X server using pyvirtualdisplay
redirect program display to Xvfb server by setting $DISPLAY variable.
wait some seconds
take screenshot by pyscreenshot which needs scrot.
use .. image:: directive to display image
Installation
General
Ubuntu
sudo apt-get install python-pip sudo apt-get install scrot sudo apt-get install xvfb sudo apt-get install xserver-xephyr sudo apt-get install python-imaging sudo pip install sphinxcontrib-programscreenshot
Uninstall
# as root pip uninstall sphinxcontrib-programscreenshot
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinxcontrib-programscreenshot-0.0.5.tar.gz.
File metadata
- Download URL: sphinxcontrib-programscreenshot-0.0.5.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2e44e8afea76ad566bc69454557b39c157c58fcac78eb1106bfdad6e11da0737
|
|
| MD5 |
0adf7874cfbe3aacbae52ec62ca12237
|
|
| BLAKE2b-256 |
d9d652c2c0a650b428dd4f2cd931043ff40bed681ce3ce32d8d138288a5b7aec
|
