[components docs] Opt-in to regenerating screenshots

Author: benpankow

docs/Makefile

@@ -32,6 +32,9 @@ sphinx_objects_inv:
 regenerate_cli_snippets:
 	cd ../examples/docs_beta_snippets && tox -e docs_snapshot_update && echo "\nSnippets regenerated!"
 
+regenerate_cli_snippets_and_screenshots:
+	cd ../examples/docs_beta_snippets && EXTRA_PARAMS='--update-screenshots' tox -e docs_snapshot_update && echo "\nSnippets regenerated!"
+
 regenerate_cli_snippets_and_test:
 	cd ../examples/docs_beta_snippets && tox -e docs_snapshot_update && tox -e docs_snapshot_test && echo "\nSnippets regenerated and tested!"
 

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/conftest.py

@@ -8,13 +8,22 @@ def pytest_addoption(parser: pytest.Parser) -> None:
         "--update-snippets",
         action="store_true",
     )
+    parser.addoption(
+        "--update-screenshots",
+        action="store_true",
+    )
 
 
 @pytest.fixture
 def update_snippets(request: pytest.FixtureRequest) -> bool:
     return bool(request.config.getoption("--update-snippets"))
 
 
+@pytest.fixture
+def update_screenshots(request: pytest.FixtureRequest) -> bool:
+    return bool(request.config.getoption("--update-screenshots"))
+
+
 @pytest.fixture(scope="session")
 def get_selenium_driver():
     from selenium import webdriver

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs_creating_a_component.py

@@ -29,7 +29,9 @@
 )
 
 
-def test_components_docs_index(update_snippets: bool, get_selenium_driver) -> None:
+def test_components_docs_index(
+    update_snippets: bool, update_screenshots: bool, get_selenium_driver
+) -> None:
     snip_no = 0
 
     def next_snip_no():
@@ -130,7 +132,7 @@ def next_snip_no():
             / "projects-and-components"
             / "components"
             / "component-type-docs.png",
-            update_snippets=update_snippets,
+            update_screenshots=update_screenshots,
         )
 
         #########################################################

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/utils.py

@@ -286,11 +286,11 @@ def screenshot_page(
     get_webdriver: "Callable[[], webdriver.Chrome]",
     url: str,
     path: Path,
-    update_snippets: bool,
+    update_screenshots: bool,
     width: Optional[int] = 1024,
     height: Optional[int] = 768,
 ) -> None:
-    if not update_snippets:
+    if not update_screenshots:
         return
     webdriver = get_webdriver()
     webdriver.set_window_size(width, height)

examples/docs_beta_snippets/tox.ini

@@ -8,6 +8,7 @@ passenv =
     COVERALLS_REPO_TOKEN
     POSTGRES_TEST_DB_HOST
     BUILDKITE*
+    EXTRA_PARAMS
 install_command = uv pip install {opts} {packages}
 deps =
   duckdb
@@ -92,4 +93,4 @@ commands =
   docs_snapshot_test: sh ./docs_beta_snippets_tests/ensure_snapshot_deps.sh
   docs_snapshot_test: pytest -c ../../pyproject.toml -vv {posargs} docs_beta_snippets_tests/snippet_checks
   docs_snapshot_update: sh ./docs_beta_snippets_tests/ensure_snapshot_deps.sh
-  docs_snapshot_update: pytest -c ../../pyproject.toml -vv {posargs} docs_beta_snippets_tests/snippet_checks --update-snippets
+  docs_snapshot_update: pytest -c ../../pyproject.toml -vv {posargs} docs_beta_snippets_tests/snippet_checks --update-snippets {env:EXTRA_PARAMS}