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-0.3.0.tar.gz (15.9 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-0.3.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinxcontrib_screenshot-0.3.0.tar.gz
Algorithm Hash digest
SHA256 c87aca68e3af7e67b02a19765f92d31b1afb0f6657b28e07fe46362e790f5de2
MD5 1a15311e91c310a1ad6bd5614b2d0fe0
BLAKE2b-256 ea94fc0095d592098fe67cedb4faed90fe36de0589e84e3244baf08777f5fca2

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_screenshot-0.3.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-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_screenshot-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d9a30d46b47113fb790776548520963c153e171e1e3b7952dd1f4c31de5be4ba
MD5 379669e4cc6e7d7b3cf6b8b74c5fe5dc
BLAKE2b-256 5f14e73057b4c265028040ba9fc81228b8926073f92ab396880400bcbc5db274

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinxcontrib_screenshot-0.3.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