Skip to main content

Sphinx extension to include screenshot of programs

Project description

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

  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

Installation

General

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-programscreenshot, version 0.0.3dev-20110422
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-programscreenshot-0.0.3dev-20110422.tar.gz (38.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page