sphinxcontrib-screenshot 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

sphinxcontrib/screenshot.py

@@ -32,7 +32,7 @@ Meta = typing.TypedDict('Meta', {
     'parallel_write_safe': bool
 })
 
-__version__ = '0.1.1'
+__version__ = '0.1.3'
 
 
 class ScreenshotDirective(SphinxDirective):
@@ -72,6 +72,21 @@ class ScreenshotDirective(SphinxDirective):
 
     document.querySelector('button').click();
   ```
+
+  Use `figclass` option if you want to specify a class name to the image.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+    :figclass: foo
+  ```
+
+  It also generates a PDF file when `pdf` option is given, which might be
+  useful when you need scalable image assets.
+
+  ```rst
+  .. screenshot:: http://www.example.com
+    :pdf:
+  ```
   """
 
   required_arguments = 1  # URL
@@ -80,12 +95,14 @@ class ScreenshotDirective(SphinxDirective):
       'height': directives.positive_int,
       'width': directives.positive_int,
       'caption': directives.unchanged,
+      'figclass': directives.unchanged,
+      'pdf': directives.flag,
   }
   pool = ThreadPoolExecutor()
 
   @staticmethod
   def take_screenshot(url: str, width: int, height: int, filepath: str,
-                      init_script: str, interactions: str):
+                      init_script: str, interactions: str, generate_pdf: bool):
     """Takes a screenshot with Playwright's Chromium browser.
 
     Args:
@@ -98,6 +115,7 @@ class ScreenshotDirective(SphinxDirective):
         https://playwright.dev/python/docs/api/class-page#page-add-init-script
       interactions (str): JavaScript code to run before taking the screenshot
         after the page was loaded.
+      generate_pdf (bool): Generate a PDF file along with the screenshot.
     """
     with sync_playwright() as playwright:
       browser = playwright.chromium.launch()
@@ -118,6 +136,10 @@ class ScreenshotDirective(SphinxDirective):
         raise RuntimeError('Timeout error occured at %s in executing\n%s' %
                            (url, interactions))
       page.screenshot(path=filepath)
+      if generate_pdf:
+        page.emulate_media(media='screen')
+        root, ext = os.path.splitext(filepath)
+        page.pdf(width=f'{width}px', height=f'{height}px', path=root + '.pdf')
       page.close()
       browser.close()
 
@@ -133,6 +155,8 @@ class ScreenshotDirective(SphinxDirective):
     height = self.options.get('height', 960)
     width = self.options.get('width', 1280)
     caption_text = self.options.get('caption', '')
+    figclass = self.options.get('figclass', '')
+    pdf = 'pdf' in self.options
     interactions = '\n'.join(self.content)
 
     if urlparse(url).scheme not in {'http', 'https'}:
@@ -148,7 +172,7 @@ class ScreenshotDirective(SphinxDirective):
     if not os.path.exists(filepath):
       fut = self.pool.submit(ScreenshotDirective.take_screenshot, url, width,
                              height, filepath, screenshot_init_script,
-                             interactions)
+                             interactions, pdf)
       fut.result()
 
     # Create image and figure nodes
@@ -158,6 +182,9 @@ class ScreenshotDirective(SphinxDirective):
     image_node = nodes.image(uri=rel_filepath)
     figure_node = nodes.figure('', image_node)
 
+    if figclass:
+      figure_node['classes'].append(figclass)
+
     if caption_text:
       parsed = nodes.Element()
       self.state.nested_parse(

{sphinxcontrib_screenshot-0.1.1.dist-info → sphinxcontrib_screenshot-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinxcontrib-screenshot
-Version: 0.1.1
+Version: 0.1.3
 Summary: A Shpinx extension to embed webpage screenshots.
 Home-page: https://github.com/tushuhei/sphinxcontrib-screenshot/
 Author: Shuhei Iitsuka
@@ -18,21 +18,21 @@ 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: sphinx[test] ; 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'
+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: sphinx[test]; 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
 

sphinxcontrib_screenshot-0.1.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+sphinxcontrib/screenshot.py,sha256=rTcbf2bx5DiRIGKcA8dL7jbi-GwfrW7-aXU83M5vAlY,6829
+sphinxcontrib_screenshot-0.1.3.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+sphinxcontrib_screenshot-0.1.3.dist-info/METADATA,sha256=T6kkviJZwZe0ZtYllM4YwhlI9qiKtoTbnI6OAcxlvII,3652
+sphinxcontrib_screenshot-0.1.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+sphinxcontrib_screenshot-0.1.3.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sphinxcontrib_screenshot-0.1.3.dist-info/RECORD,,

{sphinxcontrib_screenshot-0.1.1.dist-info → sphinxcontrib_screenshot-0.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sphinxcontrib_screenshot-0.1.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-sphinxcontrib/screenshot.py,sha256=voSjROC2WAs0K--pf6mtzDxO29CVBfoOe_TcY06vZwg,5985
-sphinxcontrib_screenshot-0.1.1.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-sphinxcontrib_screenshot-0.1.1.dist-info/METADATA,sha256=1lmWqgT2Ol8tFKD8HP9OpmEwWwQ4IfaHSw_5mfJnN1o,3667
-sphinxcontrib_screenshot-0.1.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-sphinxcontrib_screenshot-0.1.1.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sphinxcontrib_screenshot-0.1.1.dist-info/RECORD,,