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
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
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-programscreenshot 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib-programscreenshot-0.0.5.tar.gz | 7.9 kB | Without provenance | Details for sphinxcontrib-programscreenshot-0.0.5.tar.gz |
Release files / sphinxcontrib-programscreenshot-0.0.5.tar.gz
| Download URL | sphinxcontrib-programscreenshot-0.0.5.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2e44e8afea76ad566bc69454557b39c157c58fcac78eb1106bfdad6e11da0737
|
|
BLAKE2b-256 checksum How to use checksums |
d9d652c2c0a650b428dd4f2cd931043ff40bed681ce3ce32d8d138288a5b7aec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-programscreenshot 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
