How to install sphinxcontrib-programscreenshot
- Download and install ActivePython
- Open Command Prompt
- Type
pypm install sphinxcontrib-programscreenshot
Lastest release
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