sphinxcontrib-screenshot 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

sphinxcontrib/screenshot.py

@@ -32,7 +32,7 @@ Meta = typing.TypedDict('Meta', {
     'parallel_write_safe': bool
 })
 
-__version__ = '0.1.0'
+__version__ = '0.1.2'
 
 
 class ScreenshotDirective(SphinxDirective):
@@ -80,6 +80,7 @@ class ScreenshotDirective(SphinxDirective):
       'height': directives.positive_int,
       'width': directives.positive_int,
       'caption': directives.unchanged,
+      'figclass': directives.unchanged,
   }
   pool = ThreadPoolExecutor()
 
@@ -133,6 +134,7 @@ 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', '')
     interactions = '\n'.join(self.content)
 
     if urlparse(url).scheme not in {'http', 'https'}:
@@ -158,6 +160,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.0.dist-info → sphinxcontrib_screenshot-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sphinxcontrib-screenshot
-Version: 0.1.0
+Version: 0.1.2
 Summary: A Shpinx extension to embed webpage screenshots.
 Home-page: https://github.com/tushuhei/sphinxcontrib-screenshot/
 Author: Shuhei Iitsuka
@@ -25,6 +25,7 @@ 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'
@@ -37,6 +38,8 @@ Requires-Dist: yapf ; extra == 'dev'
 
 A Sphinx extension to embed website screenshots.
 
+![Example screenshot](https://raw.githubusercontent.com/tushuhei/sphinxcontrib-screenshot/main/example.png)
+
 ## Install
 
 ```bash
@@ -73,12 +76,26 @@ You can include a caption for the screenshot's `figure` directive.
   :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).
+You can describe the interaction that you want to have with the webpage before taking a screenshot in JavaScript.
 
 ```rst
 .. screenshot:: http://www.example.com
 
-    page.get_by_role('link').click()
+  document.querySelector('button').click();
+```
+
+## Pro tips
+`sphinxcontrib-screenshot` supports URLs with the HTTP and HTTPS protocols.
+To take screenshots of local files and build the document while running a local server for them, you can use the NPM library [concurrently](https://www.npmjs.com/package/concurrently) in the following way:
+
+### Build the document
+```bash
+  npx --yes concurrently -k --success=first "make html" "python3 -m http.server 3000 --directory=examples"
+```
+
+### Watch and build the document
+```bash
+  npx --yes concurrently -k "make livehtml" "python3 -m http.server 3000 --directory=examples"
 ```
 
 

sphinxcontrib_screenshot-0.1.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+sphinxcontrib/screenshot.py,sha256=Ri86PkBZ4EMYCj1BgKT9ZfQbEh6dVJRFr2n_E5cf9Ko,6137
+sphinxcontrib_screenshot-0.1.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+sphinxcontrib_screenshot-0.1.2.dist-info/METADATA,sha256=lF-Qzmb4dvtCHvVzeqhvmfIdc4IUa7Sk-EVez6L4Dp8,3667
+sphinxcontrib_screenshot-0.1.2.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+sphinxcontrib_screenshot-0.1.2.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sphinxcontrib_screenshot-0.1.2.dist-info/RECORD,,

{sphinxcontrib_screenshot-0.1.0.dist-info → sphinxcontrib_screenshot-0.1.2.dist-info}/WHEEL

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

sphinxcontrib_screenshot-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-sphinxcontrib/screenshot.py,sha256=zEapAWGqPLjSYqBtSBT6iPmXDMaDnU6VvUOhovZsHU8,5985
-sphinxcontrib_screenshot-0.1.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-sphinxcontrib_screenshot-0.1.0.dist-info/METADATA,sha256=jp_CLzybwMIYm2goiQm_Dwnj_G6_pmEwEQBey8cFIkI,3001
-sphinxcontrib_screenshot-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-sphinxcontrib_screenshot-0.1.0.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sphinxcontrib_screenshot-0.1.0.dist-info/RECORD,,