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.0.0.tar.gz (16.0 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.0.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinxcontrib_screenshot-1.0.0.tar.gz
  • Upload date:
  • Size: 16.0 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.0.0.tar.gz
Algorithm Hash digest
SHA256 cd7616b67899c470331dc359b2cf1c064df6849befb0e6e1b280e812d6d03a18
MD5 869115897ea15870b5e1100018786ba3
BLAKE2b-256 e392a94ea9e9637f1743f492702857d4126ec54c45fcbed5f7f9fdfda91385eb

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinxcontrib_screenshot-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e04eb14f31b29eda334bcddfa1584677cecf74531fe18387212c2f2b157d8a21
MD5 27ca1c86b35e7968c89a9b2a27c3ee8c
BLAKE2b-256 003ac81cd8f8b7f6c08898b03f12e4e23d4746e33daa0145734bd4632b21e6e3

See more details on using hashes here.

Provenance

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