sphinxcontrib-programscreenshot is a Sphinx 1.0 extension that executes programs during the build step and includes their screenshot into the documentation. GUI version of the sphinxcontrib.programoutput extension.
.. program-screenshot:: xmessage hello
How it works
1. start Xvfb headless X server using pyvirtualdisplay
2. redirect program display to Xvfb server by setting $DISPLAY variable.
3. wait some seconds
4. take screenshot by pyscreenshot which needs scrot.
5. use .. image:: directive to display image
- install Xvfb and Xephyr
- install PIL
- install scrot
- install pip
- install the program:
# as root
pip install sphinxcontrib-programscreenshot
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
# as root
pip uninstall sphinxcontrib-programscreenshot