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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxcontrib_screenshot-2.1.0.tar.gz.
File metadata
- Download URL: sphinxcontrib_screenshot-2.1.0.tar.gz
- Upload date:
- Size: 34.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7c4fdc181af6198bfc48a374d3ac8ce8982d5c818161c8bf7ebd163285dbcf62
|
|
| MD5 |
95f5b1be1f813bbbb8e1a131572a91dd
|
|
| BLAKE2b-256 |
736e114671087edba62a18b87051334964a1c2f6ed130a060e30c9ced4c045c7
|
Provenance
The following attestation bundles were made for sphinxcontrib_screenshot-2.1.0.tar.gz:
Publisher:
publish.yml on tushuhei/sphinxcontrib-screenshot
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxcontrib_screenshot-2.1.0.tar.gz -
Subject digest:
7c4fdc181af6198bfc48a374d3ac8ce8982d5c818161c8bf7ebd163285dbcf62 - Sigstore transparency entry: 2064580930
- Sigstore integration time:
-
Permalink:
tushuhei/sphinxcontrib-screenshot@9e61d1b0810c17a01e2ccfb5d4979b3d5b92ccb5 -
Branch / Tag:
refs/tags/v2.1.0 - Owner: https://github.com/tushuhei
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9e61d1b0810c17a01e2ccfb5d4979b3d5b92ccb5 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinxcontrib_screenshot-2.1.0-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_screenshot-2.1.0-py3-none-any.whl
- Upload date:
- Size: 31.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a6813c65d2a7a424fcfd2efcc8866eea4d2ec9fc02b3d78638faae3af3b855a
|
|
| MD5 |
39e74a2190d8aea9812b803d29c077ef
|
|
| BLAKE2b-256 |
a3d43e25db7f32260681a5a67730592b8f3372874b1b2a88a12b9c6d4de517c1
|
Provenance
The following attestation bundles were made for sphinxcontrib_screenshot-2.1.0-py3-none-any.whl:
Publisher:
publish.yml on tushuhei/sphinxcontrib-screenshot
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxcontrib_screenshot-2.1.0-py3-none-any.whl -
Subject digest:
1a6813c65d2a7a424fcfd2efcc8866eea4d2ec9fc02b3d78638faae3af3b855a - Sigstore transparency entry: 2064581060
- Sigstore integration time:
-
Permalink:
tushuhei/sphinxcontrib-screenshot@9e61d1b0810c17a01e2ccfb5d4979b3d5b92ccb5 -
Branch / Tag:
refs/tags/v2.1.0 - Owner: https://github.com/tushuhei
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9e61d1b0810c17a01e2ccfb5d4979b3d5b92ccb5 -
Trigger Event:
push
-
Statement type:
