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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sunpy-sphinx-theme
-Version: 2.1.0
+Version: 2.2.0
 Summary: The sphinx theme for the SunPy website and documentation.
 Author: The SunPy Developers
 License: BSD 2-Clause License
@@ -36,19 +36,18 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Theme
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: BSD License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pydata-sphinx-theme~=0.16.0
-Requires-Dist: sphinx
+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"
 Requires-Dist: sphinx-automodapi; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: sphinx-design; extra == "docs"
 Requires-Dist: sphinx-gallery; extra == "docs"
-Requires-Dist: sphinx-hoverxref; extra == "docs"
 Requires-Dist: sphinx-togglebutton; extra == "docs"
 Requires-Dist: sunpy; extra == "docs"
 Dynamic: license-file

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

@@ -19,12 +19,12 @@ classifiers = [
   "Framework :: Sphinx",
   "Framework :: Sphinx :: Theme",
   "Operating System :: OS Independent",
-  "License :: OSI Approved :: BSD License",
 ]
 requires-python = ">=3.9"
 dependencies = [
-  "pydata-sphinx-theme~=0.16.0",
-  "sphinx"
+  "pydata-sphinx-theme~=0.17",
+  "sphinxext-opengraph>=0.13",
+  "sphinx>=7.3.0"
 ]
 
 [project.optional-dependencies]
@@ -34,7 +34,6 @@ docs = [
   "sphinx-copybutton",
   "sphinx-design",
   "sphinx-gallery",
-  "sphinx-hoverxref",
   "sphinx-togglebutton",
   "sunpy",
 ]
@@ -65,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.0 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme/__init__.py

@@ -2,18 +2,29 @@
 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):
+    """
+    This gets the user configured options and the defaults and merges them.
+    """
+    return {**app.builder.theme.get_options(), **utils.get_theme_options_dict(app)}
+
 
 def get_html_theme_path():
     """
@@ -23,66 +34,6 @@ def get_html_theme_path():
     return parent / "theme" / "sunpy"
 
 
-def default_navbar():
-    return [
-        (
-            "About",
-            [
-                ("Our Mission", "about/", 2),
-                ("SunPy Project", "about/project/", 2),
-                ("Presentations", "about/presentations/", 2),
-                ("Meetings", "about/meetings/", 2),
-                ("Code of Conduct", "coc/", 2),
-            ],
-        ),
-        (
-            "Documentation",
-            [
-                # Core goes first always
-                ("sunpy", "https://docs.sunpy.org/", 3),
-                # Other affiliated packages are in alphabetical order
-                ("aiapy", "https://aiapy.readthedocs.io/", 3),
-                ("dkist", "https://docs.dkist.nso.edu/projects/python-tools", 3),
-                ("drms", "https://docs.sunpy.org/projects/drms/", 3),
-                ("irispy", "https://irispy.readthedocs.io/", 3),
-                ("ndcube", "https://docs.sunpy.org/projects/ndcube/", 3),
-                ("roentgen", "https://roentgen.readthedocs.io/", 3),
-                ("scope", "https://statistical-confidence-of-oscillatory-processes-with-emd.readthedocs.io", 3),
-                ("solarmach", "https://solarmach.readthedocs.io/en/stable/", 3),
-                ("sunkit-image", "https://docs.sunpy.org/projects/sunkit-image/", 3),
-                ("sunkit-instruments ", "https://docs.sunpy.org/projects/sunkit-instruments/", 3),
-                ("sunkit-magex", "https://docs.sunpy.org/projects/sunkit-magex/", 3),
-                ("sunkit-pyvista", "https://docs.sunpy.org/projects/sunkit-pyvista/", 3),
-                ("sunpy-soar", "https://docs.sunpy.org/projects/soar/", 3),
-                ("sunraster", "https://docs.sunpy.org/projects/sunraster/", 3),
-                ("xrtpy", "https://xrtpy.readthedocs.io/", 3),
-                # Provisional packages submenu
-                (
-                    "Provisional",
-                    [
-                        ("pyflct", "https://pyflct.readthedocs.io/", 3),
-                        ("radiospectra", "https://docs.sunpy.org/projects/radiospectra/", 3),
-                    ],
-                ),
-                # Tools submenu
-                (
-                    "Tools",
-                    [
-                        ("ablog", "https://ablog.readthedocs.io/en/stable/", 3),
-                        ("mpl-animators", "https://docs.sunpy.org/projects/mpl-animators/", 3),
-                        ("streamtracer", "https://docs.sunpy.org/projects/streamtracer/", 3),
-                    ],
-                ),
-            ],
-        ),
-        ("Packages", "affiliated/", 2),
-        ("Get Help", "help/", 2),
-        ("Contribute", "contribute/", 2),
-        ("Blog", "blog/", 2),
-        ("Cite SunPy", "https://docs.sunpy.org/en/stable/citation.html", 3),
-    ]
-
-
 def update_config(app) -> None:
     """
     Update config with new default values and handle deprecated keys.
@@ -91,33 +42,49 @@ def update_config(app) -> None:
     # At this point, modifying app.config.html_theme_options will NOT update the
     # page's HTML context (e.g. in jinja, `theme_keyword`).
     # To do this, you must manually modify `app.builder.theme_options`.
+    theme_options_with_defaults = get_theme_options(app)
     theme_options = utils.get_theme_options_dict(app)
 
-    if theme_options.get("sst_logo") and not isinstance(theme_options["sst_logo"], dict):
+    if theme_options_with_defaults.get("sst_logo") and not isinstance(theme_options_with_defaults["sst_logo"], dict):
         sst_logo = str(theme_options["sst_logo"])
         theme_options["sst_logo"] = {"light": sst_logo, "dark": sst_logo}
 
-    theme_options["sst_is_root"] = bool(theme_options.get("sst_is_root", False))
-
-    if not theme_options.get("navbar_links"):
-        theme_options["navbar_links"] = default_navbar()
-
-    if not theme_options.get("footer_links", False):
-        theme_options["footer_links"] = [
-            ("Code", "https://github.com/sunpy", 3),
-            ("Forum", "https://community.openastronomy.org/c/sunpy", 3),
-            ("Chat", "https://openastronomy.element.io/#/room/#sunpy:openastronomy.org", 3),
-        ]
+    theme_options["sst_is_root"] = bool(theme_options_with_defaults.get("sst_is_root", False))
 
-    # TODO: This is nasty
     # Set the default value of show_source to False unless it's specified in the user config
-    if "html_show_sourcelink" not in app.config._raw_config:  # NOQA: SLF001
+    if not utils.config_provided_by_user(app, "html_show_sourcelink"):
         app.config.html_show_sourcelink = False
 
     # Set the logo to the sunpy logo unless it's overridden in the user config
-    if "html_logo" not in app.config._raw_config:  # NOQA: SLF001
+    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 (
+        "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):
     """
@@ -156,13 +123,45 @@ 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.
     """
-    theme_config = utils.get_theme_options_dict(app)
+    theme_config = get_theme_options(app)
     search_projects = theme_config.get("rtd_search_projects", None)
-    if search_projects is None:
+    if not search_projects:
         navbar_links = theme_config["navbar_links"]
         doc_links = next(section[1] for section in navbar_links if section[0] == "Documentation")
 
@@ -180,6 +179,9 @@ def generate_search_config(app):
 
         search_projects = filter_doc_links(doc_links)
 
+    if extra_search_projects := theme_config.get("rtd_extra_search_projects", None):
+        search_projects += filter_doc_links(extra_search_projects)
+
     load_more_label = theme_config.get("rtd_search_load_more_label", "Load more results")
     no_results_label = theme_config.get("rtd_search_no_results_label", "There are no results for this search")
     script = dedent(f"""
@@ -198,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.0 → 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);
@@ -177,11 +187,6 @@ div.math {
   --bs-modal-bg: var(--pst-color-background);
 }
 
-/* Flip the colours on graphviz graphs on dark mode */
-html[data-theme="dark"] div.graphviz > object.inheritance {
-  filter: invert(0.9);
-}
-
 /* Top Nav */
 .bd-header {
   background-color: var(--sst-header-background) !important;
@@ -223,10 +228,27 @@ html[data-theme="dark"] div.graphviz > object.inheritance {
   color: var(--sst-accent-color-bright);
 }
 
-html .pst-navbar-icon {
+/* Change the top navbar toggles and icons in the header to be light */
+.bd-header button.sidebar-toggle,
+html .navbar-header-items__end .pst-navbar-icon,
+html .navbar-header-items__end .pst-navbar-icon:visited {
   color: var(--sst-header-text);
 }
 
+/* Don't style sidebar links as visited color */
+html .pst-navbar-icon:visited {
+  color: var(--pst-color-text-muted);
+}
+
+html .pst-navbar-icon:hover {
+  color: var(--pst-color-secondary);
+}
+
+/* Don't put an underline on the icons when hovering */
+html .pst-navbar-icon:hover::before {
+  border-bottom: none;
+}
+
 .search-button {
   color: var(--sst-header-text);
 }
@@ -278,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 {
@@ -307,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 {
@@ -456,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;
 }
@@ -470,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.2.0/src/sunpy_sphinx_theme/theme/sunpy/theme.toml

@@ -0,0 +1,80 @@
+[theme]
+inherit = "pydata_sphinx_theme"
+sidebars = [
+    "components/navbar-logo.html",
+    "components/sst-sidebar-nav.html",
+]
+
+[options]
+navbar_start = "components/navbar_start.html"
+navbar_center = "components/navbar_center.html"
+footer_start = "copyright.html"
+footer_center = "components/footer-links.html"
+footer_end = "components/built-with.html"
+
+sst_site_root = "https://sunpy.org"
+sst_is_root = false
+sst_project_name = "SunPy"
+sst_logo = ""
+navbar_links = [
+    ["About",
+        [
+            ["Our Mission", "about/", 2],
+            ["SunPy Project", "about/project/", 2],
+            ["Presentations", "about/presentations/", 2],
+            ["Meetings", "about/meetings/", 2],
+            ["Code of Conduct", "coc/", 2]
+        ]
+    ],
+    ["Documentation",
+        [
+            ["sunpy", "https://docs.sunpy.org/", 3],
+            ["aiapy", "https://aiapy.readthedocs.io/", 3],
+            ["dkist", "https://docs.dkist.nso.edu/projects/python-tools", 3],
+            ["drms", "https://docs.sunpy.org/projects/drms/", 3],
+            ["irispy", "https://irispy.readthedocs.io/", 3],
+            ["ndcube", "https://docs.sunpy.org/projects/ndcube/", 3],
+            ["roentgen", "https://roentgen.readthedocs.io/", 3],
+            ["scope", "https://statistical-confidence-of-oscillatory-processes-with-emd.readthedocs.io", 3],
+            ["solarmach", "https://solarmach.readthedocs.io/en/stable/", 3],
+            ["sunkit-image", "https://docs.sunpy.org/projects/sunkit-image/", 3],
+            ["sunkit-instruments ", "https://docs.sunpy.org/projects/sunkit-instruments/", 3],
+            ["sunkit-magex", "https://docs.sunpy.org/projects/sunkit-magex/", 3],
+            ["sunkit-pyvista", "https://docs.sunpy.org/projects/sunkit-pyvista/", 3],
+            ["sunpy-soar", "https://docs.sunpy.org/projects/soar/", 3],
+            ["sunraster", "https://docs.sunpy.org/projects/sunraster/", 3],
+            ["xrtpy", "https://xrtpy.readthedocs.io/", 3],
+            ["Provisional",
+                [
+                    ["pyflct", "https://pyflct.readthedocs.io/", 3],
+                    ["radiospectra", "https://docs.sunpy.org/projects/radiospectra/", 3]
+                ]
+            ],
+            ["Tools",
+                [
+                    ["ablog", "https://ablog.readthedocs.io/en/stable/", 3],
+                    ["mpl-animators", "https://docs.sunpy.org/projects/mpl-animators/", 3],
+                    ["streamtracer", "https://docs.sunpy.org/projects/streamtracer/", 3]
+                ]
+            ]
+        ]
+    ],
+    ["Packages", "affiliated/", 2],
+    ["Get Help", "help/", 2],
+    ["Contribute", "contribute/", 2],
+    ["Blog", "blog/", 2],
+    ["Cite SunPy", "https://docs.sunpy.org/en/stable/citation.html", 3]
+]
+footer_links = [
+    ["Code", "https://github.com/sunpy", 3],
+    ["Forum", "https://community.openastronomy.org/c/sunpy", 3],
+    ["Chat", "https://openastronomy.element.io/#/room/#sunpy:openastronomy.org", 3],
+]
+goatcounter_analytics_url = ""
+goatcounter_non_domain_endpoint = "False"
+pygment_light_style = "github-light"
+rtd_search = "True"
+rtd_search_projects = ""
+rtd_extra_search_projects = ""
+rtd_search_load_more_label = "Load more results"
+rtd_search_no_results_label = "There are no results for this search"

{sunpy_sphinx_theme-2.1.0 → 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.0
+Version: 2.2.0
 Summary: The sphinx theme for the SunPy website and documentation.
 Author: The SunPy Developers
 License: BSD 2-Clause License
@@ -36,19 +36,18 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Theme
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: BSD License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pydata-sphinx-theme~=0.16.0
-Requires-Dist: sphinx
+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"
 Requires-Dist: sphinx-automodapi; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: sphinx-design; extra == "docs"
 Requires-Dist: sphinx-gallery; extra == "docs"
-Requires-Dist: sphinx-hoverxref; extra == "docs"
 Requires-Dist: sphinx-togglebutton; extra == "docs"
 Requires-Dist: sunpy; extra == "docs"
 Dynamic: license-file

{sunpy_sphinx_theme-2.1.0 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme.egg-info/SOURCES.txt

@@ -17,7 +17,7 @@ src/sunpy_sphinx_theme.egg-info/dependency_links.txt
 src/sunpy_sphinx_theme.egg-info/entry_points.txt
 src/sunpy_sphinx_theme.egg-info/requires.txt
 src/sunpy_sphinx_theme.egg-info/top_level.txt
-src/sunpy_sphinx_theme/theme/sunpy/theme.conf
+src/sunpy_sphinx_theme/theme/sunpy/theme.toml
 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.1.0 → sunpy_sphinx_theme-2.2.0}/src/sunpy_sphinx_theme.egg-info/requires.txt

@@ -1,5 +1,6 @@
-pydata-sphinx-theme~=0.16.0
-sphinx
+pydata-sphinx-theme~=0.17
+sphinxext-opengraph>=0.13
+sphinx>=7.3.0
 
 [docs]
 matplotlib
@@ -7,6 +8,5 @@ sphinx-automodapi
 sphinx-copybutton
 sphinx-design
 sphinx-gallery
-sphinx-hoverxref
 sphinx-togglebutton
 sunpy

sunpy_sphinx_theme-2.1.0/src/sunpy_sphinx_theme/theme/sunpy/theme.conf

@@ -1,43 +0,0 @@
-[theme]
-inherit = pydata_sphinx_theme
-sidebars = components/navbar-logo.html, icon-links.html, components/sst-sidebar-nav.html
-
-[options]
-navbar_start = components/navbar_start.html
-navbar_center = components/navbar_center.html
-
-footer_start = copyright.html
-footer_center = components/footer-links.html
-footer_end = components/built-with.html
-
-# sunpy-sphinx-theme config
-# This config sets the base URL for top navbar items when sst_is_root is False
-sst_site_root = https://sunpy.org
-# If true then the site that's being built is the site that's normally deployed at sst_site_root
-sst_is_root = False
-# This is the name that appears in the top left of the navbar
-sst_project_name = SunPy
-# The logo to go in the top navbar in place of the project name
-sst_logo =
-navbar_links =
-footer_links =
-################################################################################
-# GoatCounter
-################################################################################
-# Set this URL to something like https://MYCODE.goatcounter.com/count
-goatcounter_analytics_url =
-# If you only want to count visits to sst_site_root or subdomains there of then set this to False
-# otherwise set it to another (or the same) goat counter endpoint
-goatcounter_non_domain_endpoint = False
-
-# Override the default light pygment styles
-pygment_light_style = github-light
-
-################################################################################
-# RTD Search
-################################################################################
-# Enable project-wide search with RTD
-rtd_search = True
-rtd_search_projects =
-rtd_search_load_more_label = "Load more results"
-rtd_search_no_results_label = "There are no results for this search"