sphinxcontrib-screenshot
A Sphinx extension to embed website screenshots and screencasts.
.. screenshot:: http://www.example.com
:browser: chromium
:viewport-width: 1280
:viewport-height: 960
:color-scheme: dark
:status-code: 200,302
.. screencast:: http://www.example.com
:viewport-width: 1280
:viewport-height: 960
:controls:
:muted:
document.querySelector('button').click();
await new Promise(r => setTimeout(r, 1000));
Read more in the documentation.
Notes
This extension uses Playwright to capture a screenshot of the specified website only. No data is sent to any other external server; the request is limited to the specified website. Be cautious: avoid including sensitive information (such as authentication data) in the directive content.
Contributing
See CONTRIBUTING.md for details.
License
Apache 2.0; see LICENSE for details.
Disclaimer
This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.
1 maintainer
Release files for sphinxcontrib-screenshot 2.1.0
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_screenshot-2.1.0.tar.gz | 34.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_screenshot-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 66.3 kB
Release files / sphinxcontrib_screenshot-2.1.0.tar.gz
| Download URL | sphinxcontrib_screenshot-2.1.0.tar.gz |
|---|---|
| Size | 34.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7c4fdc181af6198bfc48a374d3ac8ce8982d5c818161c8bf7ebd163285dbcf62
|
|
BLAKE2b-256 checksum How to use checksums |
736e114671087edba62a18b87051334964a1c2f6ed130a060e30c9ced4c045c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 4, 2026.
Transparency logRelease files / sphinxcontrib_screenshot-2.1.0-py3-none-any.whl
| Download URL | sphinxcontrib_screenshot-2.1.0-py3-none-any.whl |
|---|---|
| Size | 31.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1a6813c65d2a7a424fcfd2efcc8866eea4d2ec9fc02b3d78638faae3af3b855a
|
|
BLAKE2b-256 checksum How to use checksums |
a3d43e25db7f32260681a5a67730592b8f3372874b1b2a88a12b9c6d4de517c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 4, 2026.
Transparency log
