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
start Xvfb headless X server using pyvirtualdisplay
redirect GTKWave display to Xvfb server by setting $DISPLAY variable.
start GTKWave with VCD file. Options are set on command-line and in temporary rc file
temporary tcl script will set time interval and select all signals
wait until GTKWave is displayed
take screenshot by pyscreenshot which needs scrot.
image is processed: toolbar, scrollbar and empty space are removed
use .. image:: directive to display image
Installation
General
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
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-gtkwave 0.0.6
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-gtkwave-0.0.6.tar.gz | 8.5 kB | Details |
Release files / sphinxcontrib-gtkwave-0.0.6.tar.gz
| Download URL | sphinxcontrib-gtkwave-0.0.6.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
69b3a47c8c6d0fa2e30c1beed04531057b8c1a9954c86ce30f0e259c20149d8c
|
|
BLAKE2b-256 checksum How to use checksums |
36666d115492987194c214badddfe296f5161dad66af91facc78212f1563ecd6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
