Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

Download
ActivePython

sphinxcontrib-gtkwave 0.0.5dev
Sphinx extension to include screenshot of GTKWave

INSTALL>
pypm install sphinxcontrib-gtkwave

How to install sphinxcontrib-gtkwave

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install sphinxcontrib-gtkwave
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
0.0.4dev
0.0.5devNever BuiltWhy not?
0.0.4dev Available View build log
0.0.3dev Available View build log
0.0.2dev-20110822 Available View build log
0.0.1dev-20110725 Available View build log
0.0.0dev-20110708 Available View build log
Windows (64-bit)
0.0.4dev
0.0.5devNever BuiltWhy not?
0.0.4dev Available View build log
0.0.3dev Available View build log
0.0.2dev-20110822 Available View build log
0.0.1dev-20110725 Available View build log
0.0.0dev-20110708 Available View build log
Mac OS X (10.5+)
0.0.4dev
0.0.5devNever BuiltWhy not?
0.0.4dev Available View build log
0.0.3dev Available View build log
0.0.2dev-20110822 Available View build log
0.0.1dev-20110725 Available View build log
0.0.0dev-20110708 Available View build log
Linux (32-bit)
0.0.4dev
0.0.5devNever BuiltWhy not?
0.0.4dev Available View build log
0.0.3dev Available View build log
0.0.2dev-20110822 Available View build log
0.0.1dev-20110725 Available View build log
0.0.0dev-20110708 Available View build log
Linux (64-bit)
0.0.5dev Available View build log
0.0.4dev Available View build log
0.0.3dev Available View build log
0.0.2dev-20110822 Available View build log
0.0.1dev-20110725 Available View build log
0.0.0dev-20110708 Available View build log
 
Links
Author
License
BSD
Lastest release
version 0.0.5dev on Jan 9th, 2014

This Sphinx 1.0 extension executes GTKWave during the build step and includes its screenshot into the documentation. GTKWave can display wave files like VCD (value change dump).

Links:

Features

  • development on linux

Known problems

  • Python 3 is not supported
  • PDF output is not perfect
  • no unittests

Basic usage

.. gtkwave:: docs/gtkwave_output.vcd

How it works

This is a workaround, there is no image export in GTKWave

  1. start Xvfb headless X server using pyvirtualdisplay
  2. redirect GTKWave display to Xvfb server by setting $DISPLAY variable.
  3. start GTKWave with VCD file. Options are set on command-line and in temporary rc file
  4. temporary tcl script will set time interval and select all signals
  5. wait until GTKWave is displayed
  6. take screenshot by pyscreenshot which needs scrot.
  7. image is processed: toolbar, scrollbar and empty space are removed
  8. use .. image:: directive to display image

Installation

General

  • install GTKWave

  • install Xvfb and Xephyr

  • install PIL

  • install scrot

  • install pip

  • install the program:

    # as root
pip install sphinxcontrib-gtkwave
Ubuntu
sudo apt-get install gtkwave
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-gtkwave
Uninstall
# as root
pip uninstall sphinxcontrib-gtkwave

Subscribe to package updates

Last updated Jan 9th, 2014

Download Stats

Last month:1

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.