sphinxcontrib-programscreenshot

Sponsored Links:
Software Screenshot:
sphinxcontrib-programscreenshot
Software Details:
Version: 0.0.4
Upload Date: 15 Apr 15
Developer: ponty
Distribution Type: Freeware
Downloads: 4

Rating: 0.0/5 (Total Votes: 0)

Sponsored Links:

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.

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


- install Xvfb and Xephyr

- install PIL

- install scrot

- install pip

- install the program:

 # as root
 pip install sphinxcontrib-programscreenshot

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

Requirements:

  • Python
  • Sphinx

Similar Software

pywebuml
pywebuml

11 May 15

Sanzang
Sanzang

17 Feb 15

Other Software of Developer ponty

pyscreenshot
pyscreenshot

15 Apr 15

pyunpack
pyunpack

14 Apr 15

Comments to sphinxcontrib-programscreenshot

Comments not found
Add Comment
Turn on images!