sunpy-sphinx-theme 2.1.1__tar.gz → 2.2.0__tar.gz

{sunpy_sphinx_theme-2.1.1 → sunpy_sphinx_theme-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sunpy-sphinx-theme
-Version: 2.1.1
+Version: 2.2.0
 Summary: The sphinx theme for the SunPy website and documentation.
 Author: The SunPy Developers
 License: BSD 2-Clause License
@@ -40,6 +40,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: pydata-sphinx-theme~=0.17
+Requires-Dist: sphinxext-opengraph>=0.13
 Requires-Dist: sphinx>=7.3.0
 Provides-Extra: docs
 Requires-Dist: matplotlib; extra == "docs"

{sunpy_sphinx_theme-2.1.1 → sunpy_sphinx_theme-2.2.0}/pyproject.toml

@@ -23,6 +23,7 @@ classifiers = [
 requires-python = ">=3.9"
 dependencies = [
   "pydata-sphinx-theme~=0.17",
+  "sphinxext-opengraph>=0.13",
   "sphinx>=7.3.0"
 ]
 
@@ -63,3 +64,8 @@ include-package-data = true
     url = "sunpy_docs-devdeps/sunpy/docs/_build/html/index.html"
     message = "sunpy docs with devdeps preview"
     report_on_fail = true
+
+  [ tool.gilesbot.circleci_artifacts.astropy_website ]
+    url = "astropy.org/_build/html/index.html"
+    message = "Astropy website preview"
+    report_on_fail = true

{sunpy_sphinx_theme-2.1.1 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme/__init__.py

@@ -2,18 +2,22 @@
 SunPy Sphinx Theme.
 """
 
+import importlib
 import json
 import os
+import posixpath
 from functools import partial
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from textwrap import dedent, indent
-from urllib.parse import urljoin
+from urllib.parse import urljoin, urlparse
 
 from pydata_sphinx_theme import utils
 from sphinx.application import Sphinx
 
 __all__ = ["ON_RTD", "PNG_ICON", "SVG_ICON", "get_html_theme_path"]
 
+SPHINX_GALLERY_IMAGE_EXTENSIONS = {".apng", ".gif", ".jpeg", ".jpg", ".png", ".webp"}
+
 
 def get_theme_options(app):
     """
@@ -55,18 +59,32 @@ def update_config(app) -> None:
     if not utils.config_provided_by_user(app, "html_logo"):
         app.config.html_logo = str(get_html_theme_path() / "static" / "img" / "sunpy_icon.svg")
 
+    if not utils.config_provided_by_user(app, "ogp_use_first_image"):
+        app.config.ogp_use_first_image = True
+
+    if app.config.html_baseurl and not utils.config_provided_by_user(app, "ogp_site_url"):
+        app.config.ogp_site_url = app.config.html_baseurl
+
     # Include sunpy.org in extra_search_projects as long as none of
     # navbar_links, rtd_search_projects and rtd_extra_search_projects
     # are set, i.e. you are using the default sunpy set of projects.
     # Without this non-sunpy projects would have to explicitly un-set
     # rtd_extra_search_projects
     if not (
-        utils.config_provided_by_user(app, "navbar_links")
-        or utils.config_provided_by_user(app, "rtd_search_projects")
-        or utils.config_provided_by_user(app, "rtd_extra_search_projects")
+        "navbar_links" not in theme_options
+        or "rtd_search_projects" not in theme_options
+        or "rtd_extra_search_projects" not in theme_options
     ):
         theme_options["rtd_extra_search_projects"] = [["sunpyorg", "https://sunpy.org"]]
 
+    if importlib.util.find_spec("sphinx_gallery"):
+        ssi = theme_options_with_defaults["secondary_sidebar_items"].split(",")
+        if "sg_download_links" not in ssi:
+            ssi.append("sg_download_links")
+        if "sg_launcher_links" not in ssi:
+            ssi.append("sg_launcher_links")
+        theme_options["secondary_sidebar_items"] = ", ".join(ssi)
+
 
 def sst_pathto(context, document, relative_to=0):
     """
@@ -105,6 +123,38 @@ def update_html_context(app: Sphinx, pagename: str, templatename: str, context,
     context["sst_pathto"] = partial(sst_pathto, context)
 
 
+def update_opengraph_context(app: Sphinx, pagename: str, templatename: str, context, doctree) -> None:  # NOQA: ARG001
+    """
+    Add Sphinx-Gallery images to the Open Graph metadata context.
+    """
+    if doctree is None:
+        return
+
+    metadata = context.get("meta") or {}
+    if "og:image" in metadata:
+        return
+
+    for node in doctree.findall():
+        if node.__class__.__name__ != "imgsgnode" or not node.get("uri"):
+            continue
+
+        parsed_uri = urlparse(node["uri"])
+        image_suffix = PurePosixPath(parsed_uri.path).suffix.lower()
+        if image_suffix not in SPHINX_GALLERY_IMAGE_EXTENSIONS:
+            continue
+
+        if parsed_uri.scheme:
+            metadata["og:image"] = node["uri"]
+        else:
+            metadata["og:image"] = posixpath.join(app.builder.imagedir, PurePosixPath(parsed_uri.path).name)
+
+        if node.get("alt") and "og:image:alt" not in metadata:
+            metadata["og:image:alt"] = node["alt"]
+
+        context["meta"] = metadata
+        return
+
+
 def generate_search_config(app):
     """
     This function parses the config for the "Documentation" section of the theme config.
@@ -150,12 +200,15 @@ def generate_search_config(app):
 
 
 def setup(app: Sphinx):
+    app.setup_extension("sphinxext.opengraph")
+
     # Register theme
     theme_dir = get_html_theme_path()
     app.add_html_theme("sunpy", theme_dir)
     app.add_css_file("sunpy_style.css", priority=600)
     app.connect("builder-inited", update_config, priority=100)
     app.connect("builder-inited", generate_search_config, priority=500)
+    app.connect("html-page-context", update_opengraph_context, priority=400)
     app.connect("html-page-context", update_html_context)
     # Conditionally include goat counter js
     # We can't do this in update_config as that causes the scripts to be duplicated.

{sunpy_sphinx_theme-2.1.1 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme/theme/sunpy/static/sunpy_style.css

@@ -154,6 +154,16 @@ body {
   color: var(--sg-download-a-color);
 }
 
+/* Hide the download buttons in the gallery pages, as they are in the secondary side bar */
+.sphx-glr-download-link-note, /* Download link note in header */
+.binder-badge,                /* Binder launch badge in footer */
+.lite-badge,                  /* Lite launch badge in footer */
+.sphx-glr-download-jupyter,   /* Download Jupyter notebook link in footer */
+.sphx-glr-download-python,    /* Download Python script link in footer */
+.sphx-glr-download-zip        /* Download zipped link in footer */ {
+  display: none;
+}
+
 /* Global Styling */
 a:visited {
   color: var(--pst-color-link);
@@ -290,6 +300,12 @@ html[data-theme="light"] .bd-sidebar-primary .theme-switch-button span {
   border-right-color: var(--sst-accent-color-bright);
 }
 
+/* Put the logo above the version. */
+div.sidebar-primary-item > a.logo {
+  display: flex;
+  flex-direction: column;
+}
+
 /* Both left and right sidebars */
 .bd-sidebar-primary,
 .bd-sidebar-secondary {
@@ -319,7 +335,7 @@ html[data-theme="light"] .bd-sidebar-primary .theme-switch-button span {
 }
 
 img.logo__image {
-  height: var(--pst-header-height);
+  max-height: var(--pst-header-height);
 }
 
 .bd-sidebar-primary .sidebar-primary-items__end {
@@ -468,7 +484,7 @@ html[data-theme="dark"] .search-button-field:hover {
 .navbar-nav .concertina-toggle:hover,
 .bd-header .dropdown-item:hover,
 .bd-header .concertina-toggle:hover {
-  color: var(--pst-color-link-hover);
+  color: var(--sst-accent-color-bright);
   background-color: transparent;
   text-decoration: underline;
 }
@@ -482,7 +498,15 @@ html[data-theme="dark"] .search-button-field:hover {
 }
 /* Limit the height of dropdown menu to keep on screen */
 .bd-header .dropdown-menu {
+  --bs-dropdown-bg: var(--sst-header-background);
+  --bs-dropdown-color: var(--sst-header-text);
+  --bs-dropdown-link-active-bg: var(--bs-dropdown-bg);
   max-height: 80vh;
   overflow-y: auto;
   overscroll-behavior: contain;
 }
+.dropdown-item.active,
+.dropdown-item:active {
+  color: var(--bs-dropdown-link-active-color);
+  text-decoration: none;
+}

{sunpy_sphinx_theme-2.1.1 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sunpy-sphinx-theme
-Version: 2.1.1
+Version: 2.2.0
 Summary: The sphinx theme for the SunPy website and documentation.
 Author: The SunPy Developers
 License: BSD 2-Clause License
@@ -40,6 +40,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: pydata-sphinx-theme~=0.17
+Requires-Dist: sphinxext-opengraph>=0.13
 Requires-Dist: sphinx>=7.3.0
 Provides-Extra: docs
 Requires-Dist: matplotlib; extra == "docs"

{sunpy_sphinx_theme-2.1.1 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme.egg-info/requires.txt

@@ -1,4 +1,5 @@
 pydata-sphinx-theme~=0.17
+sphinxext-opengraph>=0.13
 sphinx>=7.3.0
 
 [docs]