sphinxcontrib-screenshot 0.1.0__tar.gz → 0.1.2__tar.gz

{sphinxcontrib-screenshot-0.1.0 → sphinxcontrib_screenshot-0.1.2}/PKG-INFO

@@ -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.0 → sphinxcontrib_screenshot-0.1.2}/README.md

@@ -2,6 +2,8 @@
 
 A Sphinx extension to embed website screenshots.
 
+![Example screenshot](https://raw.githubusercontent.com/tushuhei/sphinxcontrib-screenshot/main/example.png)
+
 ## Install
 
 ```bash
@@ -38,12 +40,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.0 → sphinxcontrib_screenshot-0.1.2}/setup.cfg

@@ -35,6 +35,7 @@ dev =
 	mypy
 	Pillow
 	pytest
+	sphinx[test]
 	toml
 	twine
 	types-beautifulsoup4

{sphinxcontrib-screenshot-0.1.0 → sphinxcontrib_screenshot-0.1.2}/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 → sphinxcontrib_screenshot-0.1.2}/sphinxcontrib_screenshot.egg-info/PKG-INFO

@@ -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.0 → sphinxcontrib_screenshot-0.1.2}/sphinxcontrib_screenshot.egg-info/requires.txt

@@ -9,6 +9,7 @@ isort
 mypy
 Pillow
 pytest
+sphinx[test]
 toml
 twine
 types-beautifulsoup4

{sphinxcontrib-screenshot-0.1.0 → sphinxcontrib_screenshot-0.1.2}/tests/test_it.py

@@ -29,7 +29,7 @@ def test_default(app: SphinxTestApp, status: StringIO,
 
   # Every screenshot directive should become an image.
   imgs = soup.find_all('img')
-  assert len(list(imgs)) == 3
+  assert len(list(imgs)) == 4
 
   # The image size should be set as specified.
   img_obj = Image.open(app.outdir / imgs[0]['src'])
@@ -44,7 +44,7 @@ def test_default(app: SphinxTestApp, status: StringIO,
 
   # 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'])
+  img_after_interaction = Image.open(app.outdir / imgs[2]['src'])
   assert list(img_before_interaction.getdata()) != list(
       img_after_interaction.getdata())
 
@@ -52,3 +52,6 @@ def test_default(app: SphinxTestApp, status: StringIO,
   img_with_caption_a = imgs[0]
   img_with_caption_b = imgs[1]
   assert img_with_caption_a['src'] == img_with_caption_b['src']
+
+  # The figure node should have the class name specified.
+  assert 'round' in soup.find_all('figure')[-1]['class']