This release is a pre-release and may not be stable for production use.
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
install PIL
install scrot
install setuptools or pip
install the program:
if you have setuptools installed:
# as root easy_install sphinxcontrib-programscreenshot
if you have pip installed:
# as root pip install sphinxcontrib-programscreenshot
Ubuntu
sudo apt-get install python-setuptools sudo apt-get install scrot sudo apt-get install xvfb sudo apt-get install xserver-xephyr sudo apt-get install python-imaging sudo easy_install sphinxcontrib-programscreenshot
Uninstall
# as root pip uninstall sphinxcontrib-programscreenshot
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-programscreenshot 0.0.2dev-20110223
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-programscreenshot-0.0.2dev-20110223.tar.gz | 31.1 kB | Details |
Release files / sphinxcontrib-programscreenshot-0.0.2dev-20110223.tar.gz
| Download URL | sphinxcontrib-programscreenshot-0.0.2dev-20110223.tar.gz |
|---|---|
| Size | 31.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e96075d8da2bcea211300803cc2c6cc260b7ee41a29d2cf699234a46b0ebc7f5
|
|
BLAKE2b-256 checksum How to use checksums |
e06edd868e6f17e223b278ba883dcf446bcc31454afb9fd749ee042389e08865
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
