sphinxcontrib-screenshot 2.0.0

A Sphinx extension to embed webpage screenshots.

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.