Skip to main content

A Sphinx extension to embed webpage screenshots.

Project description

sphinxcontrib-screenshot

A Sphinx extension to embed website screenshots.

.. screenshot:: http://www.example.com
  :browser: chromium
  :viewport-width: 1280
  :viewport-height: 960
  :color-scheme: dark
  :status-code: 200,302

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib_screenshot-1.1.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinxcontrib_screenshot-1.1.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinxcontrib_screenshot-1.1.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib_screenshot-1.1.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for sphinxcontrib_screenshot-1.1.0.tar.gz
Algorithm Hash digest
SHA256 729d8d3594d85510d00704276c7c1871a2a863b8b8f70072b5529ec1fed94ca9
MD5 a844369c4a3f2e690f02db5f950b9186
BLAKE2b-256 d109122153128ced55b162e127ddfd6201d13030c32bbced0e3a631fa3587ed6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_screenshot-1.1.0.tar.gz:

Publisher: publish.yml on tushuhei/sphinxcontrib-screenshot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinxcontrib_screenshot-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_screenshot-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79da225247e234f5cfc4153f08b82b13c1fb2fd269bfe8aa46c852759a152c31
MD5 934d9996a6d7a9565f9df0eb63871c61
BLAKE2b-256 1ce7f44f8fc949c227c372c604199d0c91e78d7be744b292467d1fb3198b578a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_screenshot-1.1.0-py3-none-any.whl:

Publisher: publish.yml on tushuhei/sphinxcontrib-screenshot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page