sunpy-sphinx-theme 2.4.0__tar.gz → 2.5.0__tar.gz

sunpy_sphinx_theme-2.5.0/.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+ignore-words-list = ANDed,arange,iy1,iy2,EIS,eis,EIT,eit,HAE,his,His,nd,NDData,along,alog10,FOVs,FOV,OT,ot,pn,CPY

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sunpy-sphinx-theme
-Version: 2.4.0
+Version: 2.5.0
 Summary: The sphinx theme for the SunPy website and documentation.
 Author: The SunPy Developers
 License: BSD 2-Clause License
@@ -39,7 +39,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pydata-sphinx-theme<0.24,>=0.22.0
+Requires-Dist: pydata-sphinx-theme<0.25,>=0.24.0
 Requires-Dist: sphinxext-opengraph>=0.13
 Requires-Dist: sphinx>=7.3.0
 Provides-Extra: docs
@@ -52,7 +52,10 @@ Requires-Dist: sphinx-togglebutton; extra == "docs"
 Requires-Dist: sunpy; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest>=7.0; extra == "test"
-Requires-Dist: pytest-playwright; extra == "test"
+Provides-Extra: test-playwright
+Requires-Dist: playwright==1.64.1; extra == "test-playwright"
+Requires-Dist: pytest-playwright==0.10.0; extra == "test-playwright"
+Requires-Dist: playwright-figure-tests; extra == "test-playwright"
 Dynamic: license-file
 
 # SunPy Project Sphinx Theme

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/conftest.py

@@ -19,7 +19,8 @@ if TYPE_CHECKING:
 
     from sphinx.testing.util import SphinxTestApp
 
-pytest_plugins = "sphinx.testing.fixtures"
+pytest_plugins = ("sphinx.testing.fixtures",)
+
 
 repo_path = Path(__file__).parent
 tests_path = repo_path / "src" / "sunpy_sphinx_theme" / "tests"
@@ -92,7 +93,7 @@ def sphinx_build_factory(make_app: Callable, tmp_path: Path, request) -> Callabl
 # -- global fixture to serve the built docs ----------------------------------
 
 
-@pytest.fixture(scope="module")
+@pytest.fixture(scope="session")
 def url_base():
     """Start local server on built docs and return the localhost URL as the base URL."""
     # The accessibility tests are run against a build of our documentation, so

sunpy_sphinx_theme-2.5.0/flake.nix

@@ -0,0 +1,35 @@
+{
+  description = "sunpy-sphinx-theme dev shell (provides Playwright browsers for NixOS)";
+
+  inputs = {
+    flake-parts.url = "github:hercules-ci/flake-parts";
+    nixpkgs.url = "https://channels.nixos.org/nixos-unstable/nixexprs.tar.zst";
+  };
+
+  outputs = { flake-parts, ... } @ inputs: flake-parts.lib.mkFlake { inherit inputs; } {
+    perSystem = { config, self', inputs', pkgs, system, ... }: {
+      devShells.default = pkgs.mkShell {
+        # playwright-driver.browsers provides Firefox/Chromium patched to run on
+        # NixOS. The pip `playwright` package reads PLAYWRIGHT_BROWSERS_PATH and
+        # uses these browsers directly; its version must match whatever nixpkgs
+        # pins here. nodejs is for the a11y env's npm install (axe-core).
+        # bash is needed so `nix develop --command` can evaluate shellHook
+        # (the devShell otherwise has no shell on PATH).
+        packages = with pkgs; [
+          bash
+          nodejs_latest
+          playwright-test
+          playwright-driver.browsers
+        ];
+
+        shellHook = ''
+          export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
+          export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true
+          # Browsers installed by nix so no-op the install command in tox
+          export PLAYWRIGHT_INSTALL_CMD="python -c pass"
+        '';
+      };
+    };
+    systems = [ "x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin" ];
+  };
+}

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
 ]
 requires-python = ">=3.11"
 dependencies = [
-  "pydata-sphinx-theme>=0.22.0,<0.24",
+  "pydata-sphinx-theme>=0.24.0,<0.25",
   "sphinxext-opengraph>=0.13",
   "sphinx>=7.3.0"
 ]
@@ -39,7 +39,11 @@ docs = [
 ]
 test = [
   "pytest>=7.0",
-  "pytest-playwright",
+]
+test-playwright = [
+  "playwright==1.64.1",
+  "pytest-playwright==0.10.0",
+  "playwright-figure-tests",
 ]
 
 [project.entry-points]
@@ -53,7 +57,9 @@ include-package-data = true
 [tool.pytest.ini_options]
 markers = "a11y: mark a test as an accessibility test"
 testpaths = ["tests"]
-addopts = "--durations=10"
+addopts = ["--durations=10", "-m not mpl_image_compare and not a11y"]
+mpl-results-path = "figure_test_images"
+mpl-use-full-test-name = true
 
 [ tool.gilesbot ]
   [ tool.gilesbot.circleci_artifacts.giles ]
@@ -74,6 +80,11 @@ addopts = "--durations=10"
     message = "sunpy docs with devdeps preview"
     report_on_fail = true
 
+  [ tool.gilesbot.circleci_artifacts.visual-tests-summary ]
+    url = "fig_comparison.html"
+    message = "screenshot test summary page"
+    report_on_fail = true
+
   [ tool.gilesbot.circleci_artifacts.astropy_website ]
     url = "astropy.org/_build/html/index.html"
     message = "Astropy website preview"

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/ruff.toml

@@ -57,6 +57,8 @@ lint.extend-ignore = [
     "S404", # subprocess module is possibly insecure
     "S603", # subprocess call: check for execution of untrusted input
     "ARG001", # Unused function argument (kept for interface compatibility)
+    "PLR0913", # Too many arguments in function definition
+    "PLR0917", # Too many positional arguments
 ]
 
 [lint.pydocstyle]

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/src/sunpy_sphinx_theme/tests/test_a11y.py

@@ -37,9 +37,19 @@ def filter_ignored_violations(violations, url_pathname, theme):
     for violation in violations:
         ignore = False
 
+        all_targets = [t for n in violation["nodes"] for t in n["target"]]
+
         # TODO: Our light theme link color does not pass, either fix it or just accept it
         if violation["id"] == "color-contrast" and theme == "light":
             ignore = True
+
+        # This is an upstream issue, and seems that the problem is the
+        # shortcut key text is missing from the aria-label
+        if violation["id"] == "label-content-name-mismatch" and any(
+            'search-button-field.search-button__button[aria-label="Search"]' in t for t in all_targets
+        ):
+            ignore = True
+
         # This one is probably fine, it's the headings inside the popup
         if url_pathname == "/cards.html" and violation["id"] == "heading-order":
             ignore = True

sunpy_sphinx_theme-2.5.0/src/sunpy_sphinx_theme/tests/test_screenshots.py

@@ -0,0 +1,40 @@
+from urllib.parse import urljoin
+
+import pytest
+
+
+@pytest.mark.mpl_image_compare
+@pytest.mark.parametrize(
+    "viewport",
+    [
+        pytest.param((820, 600), id="tablet-width"),
+        pytest.param((1920, 1080), id="larger-pc"),
+    ],
+)
+@pytest.mark.parametrize("theme", ["light", "dark"])
+@pytest.mark.parametrize(
+    "url_pathname",
+    [
+        "/colors.html",
+        "/customizing.html",
+        "/web-components.html",
+        "/cards.html",
+        "/subsections.html",
+        "/index.html",
+    ],
+)
+def test_screenshots_sst_docs(
+    url_base,
+    url_pathname,
+    theme,
+    viewport,
+    screenshot,
+    page,
+):
+    url_full = urljoin(url_base, url_pathname)
+    page.goto(url_full)
+
+    page.set_viewport_size({"width": viewport[0], "height": viewport[1]})
+    # Run a line of JavaScript that sets the light/dark theme on the page
+    page.evaluate(f"document.documentElement.dataset.theme = '{theme}'")
+    return screenshot.from_locator(page)

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/src/sunpy_sphinx_theme.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sunpy-sphinx-theme
-Version: 2.4.0
+Version: 2.5.0
 Summary: The sphinx theme for the SunPy website and documentation.
 Author: The SunPy Developers
 License: BSD 2-Clause License
@@ -39,7 +39,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pydata-sphinx-theme<0.24,>=0.22.0
+Requires-Dist: pydata-sphinx-theme<0.25,>=0.24.0
 Requires-Dist: sphinxext-opengraph>=0.13
 Requires-Dist: sphinx>=7.3.0
 Provides-Extra: docs
@@ -52,7 +52,10 @@ Requires-Dist: sphinx-togglebutton; extra == "docs"
 Requires-Dist: sunpy; extra == "docs"
 Provides-Extra: test
 Requires-Dist: pytest>=7.0; extra == "test"
-Requires-Dist: pytest-playwright; extra == "test"
+Provides-Extra: test-playwright
+Requires-Dist: playwright==1.64.1; extra == "test-playwright"
+Requires-Dist: pytest-playwright==0.10.0; extra == "test-playwright"
+Requires-Dist: playwright-figure-tests; extra == "test-playwright"
 Dynamic: license-file
 
 # SunPy Project Sphinx Theme

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/src/sunpy_sphinx_theme.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+.codespellrc
 .editorconfig
 .readthedocs.yaml
 .rtd-environment.yml
@@ -5,7 +6,6 @@
 LICENSE.md
 MANIFEST.in
 README.md
-_typos.toml
 conftest.py
 flake.nix
 package.json
@@ -28,6 +28,7 @@ src/sunpy_sphinx_theme/tests/test_a11y.py
 src/sunpy_sphinx_theme/tests/test_config_subtheme.py
 src/sunpy_sphinx_theme/tests/test_goatcounter.py
 src/sunpy_sphinx_theme/tests/test_options.py
+src/sunpy_sphinx_theme/tests/test_screenshots.py
 src/sunpy_sphinx_theme/tests/sites/base/conf.py
 src/sunpy_sphinx_theme/tests/sites/base/index.rst
 src/sunpy_sphinx_theme/tests/sites/derived/conf.py

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/src/sunpy_sphinx_theme.egg-info/requires.txt

@@ -1,4 +1,4 @@
-pydata-sphinx-theme<0.24,>=0.22.0
+pydata-sphinx-theme<0.25,>=0.24.0
 sphinxext-opengraph>=0.13
 sphinx>=7.3.0
 
@@ -13,4 +13,8 @@ sunpy
 
 [test]
 pytest>=7.0
-pytest-playwright
+
+[test-playwright]
+playwright==1.64.1
+pytest-playwright==0.10.0
+playwright-figure-tests

{sunpy_sphinx_theme-2.4.0 → sunpy_sphinx_theme-2.5.0}/src/sunpy_sphinx_theme.egg-info/scm_file_list.json

@@ -1,6 +1,7 @@
 {
   "files": [
     ".circleci/config.yml",
+    ".codespellrc",
     ".editorconfig",
     ".github/dependabot.yml",
     ".github/workflows/pythonpublish.yml",
@@ -12,7 +13,6 @@
     "LICENSE.md",
     "MANIFEST.in",
     "README.md",
-    "_typos.toml",
     "conftest.py",
     "docs/_static/img/Stuart-Mumford.png",
     "docs/cards.rst",
@@ -51,6 +51,7 @@
     "src/sunpy_sphinx_theme/tests/test_config_subtheme.py",
     "src/sunpy_sphinx_theme/tests/test_goatcounter.py",
     "src/sunpy_sphinx_theme/tests/test_options.py",
+    "src/sunpy_sphinx_theme/tests/test_screenshots.py",
     "src/sunpy_sphinx_theme/theme/sunpy/components/built-with.html",
     "src/sunpy_sphinx_theme/theme/sunpy/components/footer-links.html",
     "src/sunpy_sphinx_theme/theme/sunpy/components/navbar-logo.html",

sunpy_sphinx_theme-2.5.0/src/sunpy_sphinx_theme.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2.5.0",
+  "distance": 0,
+  "node": "g15af22af57634aa38fa16b42bb5ef52d03d02bb5",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-11-02"
+}

sunpy_sphinx_theme-2.4.0/_typos.toml

@@ -1,25 +0,0 @@
-default.extend-ignore-identifiers-re = [
-    "ANDed", # ANDed
-    "arange",
-    "iy1",
-    "iy2",
-    "EIS",
-    "eis",
-    "EIT",
-    "eit",
-    "HAE",
-    "hsi",
-    "Hsi",
-    "nd",
-    "NDData",
-    "alog",
-    "alog10",
-    "FOVs",
-    "FOV",
-    # HEK
-    "OT",
-    "ot",
-    # Coords,
-    "pn",
-    "CPY",
-]

sunpy_sphinx_theme-2.4.0/flake.nix

@@ -1,34 +0,0 @@
-{
-  description = "A very basic flake";
-
-  inputs = {
-    flake-parts.url = "github:hercules-ci/flake-parts";
-    nixpkgs.url = "github:nixos/nixpkgs";
-  };
-
-  outputs = { flake-parts, ... } @ inputs: flake-parts.lib.mkFlake { inherit inputs; } {
-    perSystem = { config, self', inputs', pkgs, system, ... }: {
-      devShells.default = pkgs.mkShell {
-        # venvShellHook needs venvDir set on the shell
-        venvDir = ".venv";
-
-        packages = with pkgs; [
-          nodejs_latest
-          playwright-driver.browsers
-          uv
-        ];
-
-        # runs every time you enter the shell, after activation
-        shellHook = ''
-          export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
-          export PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS=true;
-          uv sync --all-extras
-          source .venv/bin/activate
-          npm install
-        '';
-      };
-    };
-    # Declared systems that your flake supports. These will be enumerated in perSystem
-    systems = [ "x86_64-linux" "aarch64-linux" "x86_64-darwin" "aarch64-darwin" ];
-  };
-}

sunpy_sphinx_theme-2.4.0/src/sunpy_sphinx_theme.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "2.4.0",
-  "distance": 0,
-  "node": "gfd0161cbb672c0deac5247be6eb7d34cd8082cc6",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-09-30"
-}