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

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.2.2.tar.gz (12.3 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.2.2-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinxcontrib_screenshot-0.2.2.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for sphinxcontrib_screenshot-0.2.2.tar.gz
Algorithm Hash digest
SHA256 65356c34cf6e83d97cb87f103748bbaced45d348fd4db60061834c7be1011450
MD5 0df54a0bc9b98e7bb436b04685a23120
BLAKE2b-256 c5dc1d0b067925afd5987f343ff85907fd133911a14e94a6bc61f98d9c887e96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinxcontrib_screenshot-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 90a2b1f5c21147dd6cb570fc115349edd336aa127fb3c26cf4cfd22d64356aae
MD5 ded720321ab5da942e9d26ecef29d590
BLAKE2b-256 bd7453bf1ba520239d4a4ecb7dd14720e3a1090197c53d208d7d38e18b596611

See more details on using hashes here.

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