sphinxcontrib-screenshot 0.0.1__tar.gz

sphinxcontrib-screenshot-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sphinxcontrib-screenshot-0.0.1/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: sphinxcontrib-screenshot
+Version: 0.0.1
+Summary: Shpinx extension to embed a screenshot of a webpage.
+Author: Shuhei Iitsuka
+Author-email: tushuhei@gmail.com
+License: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: playwright
+Requires-Dist: sphinx
+Provides-Extra: dev
+Requires-Dist: beautifulsoup4; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: Pillow; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: types-beautifulsoup4; extra == "dev"
+Requires-Dist: types-docutils; extra == "dev"
+Requires-Dist: types-Pillow; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: yapf; extra == "dev"
+
+# sphinxcontrib-screenshot
+
+A Sphinx extension to embed website screenshots.
+
+![screenshot](https://raw.githubusercontent.com/tushuhei/sphinxcontrib-screenshot/main/example.png)
+
+## Install
+
+```bash
+pip install sphinxcontrib-screenshot
+playwright install
+```
+
+## Usage
+
+Add `sphinxcontrib.screenshot` to your `conf.py`.
+
+```py
+extensions = ["sphinxcontrib.screenshot"]
+```
+
+Then use the `screenshot` directive in your Sphinx source file.
+
+```rst
+.. screenshot:: http://www.example.com
+```
+
+You can also specify the screen size for the screenshot with `width` and `height` parameters.
+
+```rst
+.. screenshot:: http://www.example.com
+  :width: 1280
+  :height: 960
+```
+
+You can include a caption for the screenshot's `figure` directive.
+
+```rst
+.. screenshot:: http://www.example.com
+  :caption: This is a screenshot for www.example.com
+```
+
+You can describe the interaction that you want to have with the webpage before taking a screenshot. `page` is the [Playwright's Page instance](https://playwright.dev/docs/api/class-page).
+
+```rst
+.. screenshot:: http://www.example.com
+
+    page.get_by_role('link').click()
+```
+
+You can even specify the webpage with a file path.
+If it's a relative path, the origin should be the document source directory.
+
+```rst
+.. screenshot:: ./example.html
+```
+
+## Notes
+
+This extension uses [Playwright](https://playwright.dev) 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`](CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0; see [`LICENSE`](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.

sphinxcontrib-screenshot-0.0.1/README.md

@@ -0,0 +1,76 @@
+# sphinxcontrib-screenshot
+
+A Sphinx extension to embed website screenshots.
+
+![screenshot](https://raw.githubusercontent.com/tushuhei/sphinxcontrib-screenshot/main/example.png)
+
+## Install
+
+```bash
+pip install sphinxcontrib-screenshot
+playwright install
+```
+
+## Usage
+
+Add `sphinxcontrib.screenshot` to your `conf.py`.
+
+```py
+extensions = ["sphinxcontrib.screenshot"]
+```
+
+Then use the `screenshot` directive in your Sphinx source file.
+
+```rst
+.. screenshot:: http://www.example.com
+```
+
+You can also specify the screen size for the screenshot with `width` and `height` parameters.
+
+```rst
+.. screenshot:: http://www.example.com
+  :width: 1280
+  :height: 960
+```
+
+You can include a caption for the screenshot's `figure` directive.
+
+```rst
+.. screenshot:: http://www.example.com
+  :caption: This is a screenshot for www.example.com
+```
+
+You can describe the interaction that you want to have with the webpage before taking a screenshot. `page` is the [Playwright's Page instance](https://playwright.dev/docs/api/class-page).
+
+```rst
+.. screenshot:: http://www.example.com
+
+    page.get_by_role('link').click()
+```
+
+You can even specify the webpage with a file path.
+If it's a relative path, the origin should be the document source directory.
+
+```rst
+.. screenshot:: ./example.html
+```
+
+## Notes
+
+This extension uses [Playwright](https://playwright.dev) 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`](CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0; see [`LICENSE`](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.

sphinxcontrib-screenshot-0.0.1/setup.cfg

@@ -0,0 +1,58 @@
+[metadata]
+name = sphinxcontrib-screenshot
+version = 0.0.1
+description = Shpinx extension to embed a screenshot of a webpage.
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = Apache-2.0
+author = Shuhei Iitsuka
+author_email = tushuhei@gmail.com
+classifiers = 
+	Development Status :: 3 - Alpha
+	Operating System :: OS Independent
+	License :: OSI Approved :: Apache Software License
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+
+[options]
+python_requires = >= 3.8
+packages = 
+	sphinxcontrib
+include_package_data = True
+test_suite = tests
+install_requires = 
+	playwright
+	sphinx
+
+[options.extras_require]
+dev = 
+	beautifulsoup4
+	build
+	flake8
+	isort
+	mypy
+	Pillow
+	pytest
+	toml
+	twine
+	types-beautifulsoup4
+	types-docutils
+	types-Pillow
+	types-setuptools
+	yapf
+
+[yapf]
+based_on_style = yapf
+
+[flake8]
+indent-size = 2
+
+[mypy]
+python_version = 3.9
+pretty = True
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sphinxcontrib-screenshot-0.0.1/setup.py

@@ -0,0 +1,17 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from setuptools import setup
+
+setup()

sphinxcontrib-screenshot-0.0.1/sphinxcontrib/screenshot.py

@@ -0,0 +1,161 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import hashlib
+import os
+import typing
+
+from docutils import nodes
+from docutils.parsers.rst import directives
+from docutils.statemachine import ViewList
+from playwright.sync_api import sync_playwright
+from sphinx.application import Sphinx
+from sphinx.util.docutils import SphinxDirective
+
+Meta = typing.TypedDict('Meta', {
+    'version': str,
+    'parallel_read_safe': bool,
+    'parallel_write_safe': bool
+})
+
+p = sync_playwright().start()
+browser = p.chromium.launch()
+
+
+class ScreenshotDirective(SphinxDirective):
+  """Sphinx Screenshot Dirctive.
+
+  This directive embeds a screenshot of a webpage.
+
+  # Example
+
+  You can simply pass a URL for a webpage that you want to take a screenshot.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+  ```
+
+  You can also specify the screen size for the screenshot with `width` and
+  `height` parameters in pixel.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+    :width: 1280
+    :height: 960
+  ```
+
+  You can include a caption for the screenshot's `figure` directive.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+    :caption: This is a screenshot for www.example.com
+  ```
+
+  You can describe the interaction that you want to have with the webpage
+  before taking a screenshot. `page` is the
+  [Playwright's Page instance](https://playwright.dev/docs/api/class-page).
+
+  ```rst
+  .. screenshot:: http://www.example.com
+
+      page.get_by_role('link').click()
+  ```
+
+  You can even specify the webpage with a file path.
+  If it's a relative path, the origin should be the document source directory.
+
+  ```rst
+  .. screenshot:: ./example.html
+  ```
+  """
+
+  required_arguments = 1  # URL
+  has_content = True
+  option_spec = {
+      'height': directives.positive_int,
+      'width': directives.positive_int,
+      'caption': directives.unchanged,
+  }
+
+  def run(self) -> typing.List[nodes.Node]:
+    screenshot_init_script = self.env.config.screenshot_init_script if hasattr(
+        self.env.config, 'screenshot_init_script') else ''
+
+    # Ensure the screenshots directory exists
+    ss_dirpath = os.path.join(self.env.app.outdir, '_static', 'screenshots')
+    os.makedirs(ss_dirpath, exist_ok=True)
+
+    # Parse parameters
+    url_or_path = self.arguments[0]
+    height = self.options.get('height', 960)
+    width = self.options.get('width', 1280)
+    caption_text = self.options.get('caption', '')
+    interactions = '\n'.join(self.content)
+
+    # Generate filename based on hash of parameters
+    hash_input = f'{url_or_path}_{height}_{width}_{interactions}'
+    filename = hashlib.md5(hash_input.encode()).hexdigest() + '.png'
+    filepath = os.path.join(ss_dirpath, filename)
+
+    # Check if the file already exists. If not, take a screenshot
+    if not os.path.exists(filepath):
+      page = browser.new_page()
+      page.set_viewport_size({'width': width, 'height': height})
+      if screenshot_init_script:
+        page.add_init_script(screenshot_init_script)
+      if url_or_path.startswith(('http://', 'https://')):
+        page.goto(url_or_path)
+      elif os.path.isabs(url_or_path):
+        page.goto('file://' + url_or_path)
+      else:
+        page.goto('file://' + str(self.env.srcdir.joinpath(url_or_path)))
+      page.wait_for_load_state('networkidle')
+
+      # Execute interactions
+      if interactions:
+        exec(interactions)
+
+      page.screenshot(path=filepath)
+      page.close()
+
+    # Create image and figure nodes
+    docdir = os.path.dirname(self.env.doc2path(self.env.docname))
+    rel_ss_dirpath = os.path.relpath(ss_dirpath, start=docdir)
+    rel_filepath = os.path.join(rel_ss_dirpath, filename).replace(os.sep, '/')
+    image_node = nodes.image(uri=rel_filepath)
+    figure_node = nodes.figure('', image_node)
+
+    if caption_text:
+      parsed = nodes.Element()
+      self.state.nested_parse(
+          ViewList([caption_text], source=""), self.content_offset, parsed)
+      figure_node += nodes.caption(parsed[0].source or '', '',
+                                   *parsed[0].children)
+
+    return [figure_node]
+
+
+def on_build_finished(app: Sphinx, exception: Exception):
+  browser.close()
+  p.stop()
+
+
+def setup(app: Sphinx) -> Meta:
+  app.add_directive('screenshot', ScreenshotDirective)
+  app.connect("build-finished", on_build_finished)
+  return {
+      'version': '0.0.1',
+      'parallel_read_safe': True,
+      'parallel_write_safe': True,
+  }

sphinxcontrib-screenshot-0.0.1/sphinxcontrib_screenshot.egg-info/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: sphinxcontrib-screenshot
+Version: 0.0.1
+Summary: Shpinx extension to embed a screenshot of a webpage.
+Author: Shuhei Iitsuka
+Author-email: tushuhei@gmail.com
+License: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: playwright
+Requires-Dist: sphinx
+Provides-Extra: dev
+Requires-Dist: beautifulsoup4; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: Pillow; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: toml; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: types-beautifulsoup4; extra == "dev"
+Requires-Dist: types-docutils; extra == "dev"
+Requires-Dist: types-Pillow; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: yapf; extra == "dev"
+
+# sphinxcontrib-screenshot
+
+A Sphinx extension to embed website screenshots.
+
+![screenshot](https://raw.githubusercontent.com/tushuhei/sphinxcontrib-screenshot/main/example.png)
+
+## Install
+
+```bash
+pip install sphinxcontrib-screenshot
+playwright install
+```
+
+## Usage
+
+Add `sphinxcontrib.screenshot` to your `conf.py`.
+
+```py
+extensions = ["sphinxcontrib.screenshot"]
+```
+
+Then use the `screenshot` directive in your Sphinx source file.
+
+```rst
+.. screenshot:: http://www.example.com
+```
+
+You can also specify the screen size for the screenshot with `width` and `height` parameters.
+
+```rst
+.. screenshot:: http://www.example.com
+  :width: 1280
+  :height: 960
+```
+
+You can include a caption for the screenshot's `figure` directive.
+
+```rst
+.. screenshot:: http://www.example.com
+  :caption: This is a screenshot for www.example.com
+```
+
+You can describe the interaction that you want to have with the webpage before taking a screenshot. `page` is the [Playwright's Page instance](https://playwright.dev/docs/api/class-page).
+
+```rst
+.. screenshot:: http://www.example.com
+
+    page.get_by_role('link').click()
+```
+
+You can even specify the webpage with a file path.
+If it's a relative path, the origin should be the document source directory.
+
+```rst
+.. screenshot:: ./example.html
+```
+
+## Notes
+
+This extension uses [Playwright](https://playwright.dev) 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`](CONTRIBUTING.md) for details.
+
+## License
+
+Apache 2.0; see [`LICENSE`](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.

sphinxcontrib-screenshot-0.0.1/sphinxcontrib_screenshot.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+sphinxcontrib/screenshot.py
+sphinxcontrib_screenshot.egg-info/PKG-INFO
+sphinxcontrib_screenshot.egg-info/SOURCES.txt
+sphinxcontrib_screenshot.egg-info/dependency_links.txt
+sphinxcontrib_screenshot.egg-info/requires.txt
+sphinxcontrib_screenshot.egg-info/top_level.txt
+tests/test_it.py

sphinxcontrib-screenshot-0.0.1/sphinxcontrib_screenshot.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sphinxcontrib-screenshot-0.0.1/sphinxcontrib_screenshot.egg-info/requires.txt

@@ -0,0 +1,18 @@
+playwright
+sphinx
+
+[dev]
+beautifulsoup4
+build
+flake8
+isort
+mypy
+Pillow
+pytest
+toml
+twine
+types-beautifulsoup4
+types-docutils
+types-Pillow
+types-setuptools
+yapf

sphinxcontrib-screenshot-0.0.1/sphinxcontrib_screenshot.egg-info/top_level.txt

@@ -0,0 +1 @@
+sphinxcontrib

sphinxcontrib-screenshot-0.0.1/tests/test_it.py

@@ -0,0 +1,60 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from io import StringIO
+
+import pytest
+from bs4 import BeautifulSoup
+from PIL import Image
+from sphinx.testing.util import SphinxTestApp
+
+
+@pytest.mark.sphinx('html')
+def test_default(app: SphinxTestApp, status: StringIO,
+                 warning: StringIO) -> None:
+  app.build()
+  out_html = app.outdir / "index.html"
+  soup = BeautifulSoup(out_html.read_text(), "html.parser")
+
+  # Every screenshot directive should become an image.
+  imgs = soup.find_all('img')
+  assert len(list(imgs)) == 4
+
+  # The image size should be set as specified.
+  img_obj = Image.open(app.outdir / imgs[0]['src'])
+  width, height = img_obj.size
+  assert width == 480
+  assert height == 320
+
+  figures = soup.find_all('figure')
+  # The caption should be rendered.
+  figcaption = figures[0].select_one('figcaption span')
+  assert figcaption and (figcaption.get_text().strip()
+                         == 'This is a test screenshot')
+
+  # The caption should render other directives.
+  code_element = figures[1].select_one('code')
+  assert code_element and (code_element.get_text().strip()
+                           == 'http://www.example.com')
+
+  # The images should be different after the specified user interaction.
+  img_before_interaction = Image.open(app.outdir / imgs[0]['src'])
+  img_after_interaction = Image.open(app.outdir / imgs[-1]['src'])
+  assert list(img_before_interaction.getdata()) != list(
+      img_after_interaction.getdata())
+
+  # The images should be the same if the difference is only the caption.
+  img_with_caption_a = imgs[0]
+  img_with_caption_b = imgs[1]
+  assert img_with_caption_a['src'] == img_with_caption_b['src']