automatic changes from b633898 and 9c5a3d5

.git-blame-ignore-revs

@@ -5,9 +5,9 @@
 # https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile
 # https://github.com/pydata/pydata-sphinx-theme/pull/713
 #
-90550b66ace16a370caa446e54698b126fda740b  # initial black-format
-236d4c6d1f10f5da064d929e9eb594daecf23551  # apply black 20.8b1 format
-69f1a42a3b184f4ba4c98f1745779a277d56c5e2  # [pre-commit.ci] Automatic linting and formatting fixes
-a35529c9ee8d5863613df40787cda0021b3e0128  # Manual fixes for stylelint
-ce583b8f3136d52e8056c9a651bf6f92e7922f79  # Manual adjustments to autofixes
-d1ee9eb7a132cde51433e9594513319fdab41f2f  # Autofix (stylelint)
+90550b66ace16a370caa446e54698b126fda740b # initial black-format
+236d4c6d1f10f5da064d929e9eb594daecf23551 # apply black 20.8b1 format
+69f1a42a3b184f4ba4c98f1745779a277d56c5e2 # [pre-commit.ci] Automatic linting and formatting fixes
+a35529c9ee8d5863613df40787cda0021b3e0128 # Manual fixes for stylelint
+ce583b8f3136d52e8056c9a651bf6f92e7922f79 # Manual adjustments to autofixes
+d1ee9eb7a132cde51433e9594513319fdab41f2f # Autofix (stylelint)

docs/_extension/component_directive.py

@@ -6,6 +6,7 @@
 """
 
 import re
+
 from pathlib import Path
 from typing import Any, Dict, List
 
@@ -14,6 +15,7 @@
 from sphinx.util import logging
 from sphinx.util.docutils import SphinxDirective
 
+
 logger = logging.getLogger(__name__)
 
 

docs/_extension/gallery_directive.py

@@ -19,6 +19,7 @@
 from sphinx.util.docutils import SphinxDirective
 from yaml import safe_load
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -76,7 +77,7 @@ def run(self) -> List[nodes.Node]:
             path_doc = Path(path_doc).parent
             path_data = (path_doc / path_data_rel).resolve()
             if not path_data.exists():
-                logger.info(f"Could not find grid data at {path_data}.")
+                logger.info("Could not find grid data at %s.", path_data)
                 nodes.text("No grid data found at {path_data}.")
                 return
             yaml_string = path_data.read_text()

docs/conf.py

@@ -8,6 +8,7 @@
 # -- Path setup --------------------------------------------------------------
 import os
 import sys
+
 from pathlib import Path
 from typing import Any, Dict
 
@@ -16,6 +17,7 @@
 
 import pydata_sphinx_theme
 
+
 sys.path.append(str(Path(".").resolve()))
 
 # -- Project information -----------------------------------------------------
@@ -192,7 +194,8 @@
     },
     "use_edit_page_button": True,
     "show_toc_level": 1,
-    "navbar_align": "left",  # [left, content, right] For testing that the navbar items align properly
+    # [left, content, right] For testing that the navbar items align properly
+    "navbar_align": "left",
     # "show_nav_level": 2,
     "announcement": "https://raw.githubusercontent.com/pydata/pydata-sphinx-theme/main/docs/_templates/custom-template.html",
     "show_version_warning_banner": True,
@@ -294,10 +297,15 @@
 def setup_to_main(
     app: Sphinx, pagename: str, templatename: str, context, doctree
 ) -> None:
-    """Add a function that jinja can access for returning an "edit this page" link pointing to `main`."""
+    """
+    Add a function that jinja can access for returning an "edit this page" link
+    pointing to `main`.
+    """
 
     def to_main(link: str) -> str:
-        """Transform "edit on github" links and make sure they always point to the main branch.
+        """
+        Transform "edit on github" links and make sure they always point to the
+        main branch.
 
         Args:
             link: the link to the github edit interface

docs/examples/pydata.ipynb

@@ -29,6 +29,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "\n",
+    "\n",
     "rng = np.random.default_rng(seed=15485863)\n",
     "data = rng.standard_normal((100, 26))\n",
     "df = pd.DataFrame(data, columns=list(string.ascii_lowercase))\n",
@@ -51,8 +52,10 @@
     "import ipywidgets as widgets\n",
     "import numpy as np\n",
     "import pandas as pd\n",
+    "\n",
     "from IPython.display import display\n",
     "\n",
+    "\n",
     "tab = widgets.Tab()\n",
     "\n",
     "descr_str = \"Hello\"\n",
@@ -65,9 +68,9 @@
     "\n",
     "# render in output widgets\n",
     "with widget_images:\n",
-    "    display(pd.DataFrame(np.random.randn(10,10)))\n",
+    "    display(pd.DataFrame(np.random.randn(10, 10)))\n",
     "with widget_annotations:\n",
-    "    display(pd.DataFrame(np.random.randn(10,10)))\n",
+    "    display(pd.DataFrame(np.random.randn(10, 10)))\n",
     "\n",
     "tab.children = [widget_images, widget_annotations]\n",
     "tab.titles = [\"Images\", \"Annotations\"]\n",
@@ -90,6 +93,7 @@
    "source": [
     "import matplotlib.pyplot as plt\n",
     "\n",
+    "\n",
     "fig, ax = plt.subplots()\n",
     "ax.scatter(df[\"a\"], df[\"b\"], c=df[\"b\"], s=3)"
    ]
@@ -125,10 +129,13 @@
     "import plotly.express as px\n",
     "import plotly.io as pio\n",
     "\n",
+    "\n",
     "pio.renderers.default = \"notebook\"\n",
     "\n",
     "df = px.data.iris()\n",
-    "fig = px.scatter(df, x=\"sepal_width\", y=\"sepal_length\", color=\"species\", size=\"sepal_length\")\n",
+    "fig = px.scatter(\n",
+    "    df, x=\"sepal_width\", y=\"sepal_length\", color=\"species\", size=\"sepal_length\"\n",
+    ")\n",
     "fig"
    ]
   },
@@ -149,11 +156,10 @@
    "source": [
     "import xarray as xr\n",
     "\n",
+    "\n",
     "data = xr.DataArray(\n",
-    "        np.random.randn(2, 3),\n",
-    "        dims=(\"x\", \"y\"),\n",
-    "        coords={\"x\": [10, 20]}, attrs={\"foo\": \"bar\"}\n",
-    "      )\n",
+    "    np.random.randn(2, 3), dims=(\"x\", \"y\"), coords={\"x\": [10, 20]}, attrs={\"foo\": \"bar\"}\n",
+    ")\n",
     "data"
    ]
   },
@@ -174,8 +180,9 @@
    "source": [
     "from ipyleaflet import Map, basemaps\n",
     "\n",
+    "\n",
     "# display a map centered on France\n",
-    "m = Map(basemap=basemaps.Esri.WorldImagery,  zoom=5, center=[46.21, 2.21])\n",
+    "m = Map(basemap=basemaps.Esri.WorldImagery, zoom=5, center=[46.21, 2.21])\n",
     "m"
    ]
   }

docs/scripts/generate_collaborators_gallery.py

@@ -1,12 +1,17 @@
-"""Uses the GitHub API to list a gallery of all people with direct access to the repository."""
+"""
+Uses the GitHub API to list a gallery of all people with direct access to the
+repository.
+"""
 
 import json
 import shlex
+
 from pathlib import Path
 from subprocess import run
 
 from yaml import dump
 
+
 COLLABORATORS_API = "https://api.github.com/repos/pydata/pydata-sphinx-theme/collaborators?affiliation=direct"
 
 print("Grabbing latest collaborators with GitHub API via GitHub's CLI...")

docs/scripts/update_kitchen_sink.py

@@ -3,10 +3,13 @@
 from pathlib import Path
 from urllib.request import urlopen
 
+
 EXTRA_MESSAGE = """\
 .. note::
 
-   The Kitchen Sink was generated from the `Sphinx Themes website <https://sphinx-themes.org/>`_, a community-supported showcase of themes for `Sphinx <https://www.sphinx-doc.org/>`_.
+   The Kitchen Sink was generated from the
+   `Sphinx Themes website <https://sphinx-themes.org/>`_, a community-supported showcase
+   of themes for `Sphinx <https://www.sphinx-doc.org/>`_.
    Check it out to see other great themes.
 
    .. button-link:: https://sphinx-themes.org

docs/user_guide/layout.rst

@@ -593,4 +593,3 @@ Please find here the full list of keys you can use in the ``html_theme_options``
 .. include:: ../../src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
     :code: ini
     :class: highlight-ini
-

src/pydata_sphinx_theme/__init__.py

@@ -1,19 +1,22 @@
 """Bootstrap-based sphinx theme from the PyData community."""
 
 import json
+
 from functools import partial
 from pathlib import Path
 from typing import Dict
 from urllib.parse import urlparse
 
 import requests
+
 from requests.exceptions import ConnectionError, HTTPError, RetryError
 from sphinx.application import Sphinx
 from sphinx.builders.dirhtml import DirectoryHTMLBuilder
 from sphinx.errors import ExtensionError
 
 from . import edit_this_page, logo, pygments, short_link, toctree, translator, utils
 
+
 __version__ = "0.16.1dev0"
 
 
@@ -202,7 +205,7 @@ def update_and_remove_templates(
         for i in range(len(context["css_files"])):
             asset = context["css_files"][i]
             # TODO: eventually the contents of context['css_files'] etc should probably
-            #       only be _CascadingStyleSheet etc. For now, assume mixed with strings.
+            # only be _CascadingStyleSheet etc. For now, assume mixed with strings.
             asset_path = getattr(asset, "filename", str(asset))
             if asset_path == theme_css_name:
                 del context["css_files"][i]
@@ -233,7 +236,8 @@ def update_and_remove_templates(
         DOCUMENTATION_OPTIONS.theme_version = '{__version__}';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = '{json_url}';
         DOCUMENTATION_OPTIONS.theme_switcher_version_match = '{version_match}';
-        DOCUMENTATION_OPTIONS.show_version_warning_banner = {str(context["theme_show_version_warning_banner"]).lower()};
+        DOCUMENTATION_OPTIONS.show_version_warning_banner =
+            {str(context["theme_show_version_warning_banner"]).lower()};
         """
         app.add_js_file(None, body=js)
 

src/pydata_sphinx_theme/edit_this_page.py

@@ -1,6 +1,7 @@
 """Create an "edit this page" url compatible with bitbucket, gitlab and github."""
 
 import jinja2
+
 from sphinx.application import Sphinx
 from sphinx.errors import ExtensionError
 

src/pydata_sphinx_theme/locale/ca/LC_MESSAGES/sphinx.po

@@ -2,11 +2,11 @@
 # Copyright (C) 2024 ORGANIZATION
 # This file is distributed under the same license as the PROJECT project.
 # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
-# 
+#
 # Translators:
 # Cristhian Rivera, 2024
 # Oriol Abril-Pla <[email protected]>, 2024
-# 
+#
 msgid ""
 msgstr ""
 

src/pydata_sphinx_theme/locale/cs/LC_MESSAGES/sphinx.po

@@ -180,4 +180,3 @@ msgstr "Navigace na stránce"
 
 #~ msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
 #~ msgstr "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
-

src/pydata_sphinx_theme/locale/es/LC_MESSAGES/sphinx.po

@@ -2,13 +2,13 @@
 # Copyright (C) 2024 ORGANIZATION
 # This file is distributed under the same license as the PROJECT project.
 # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
-# 
+#
 # Translators:
 # Rambaud Pierrick <[email protected]>, 2023
 # Cristhian Rivera, 2024
 # Felipe Moreno, 2024
 # Tania Allard, 2024
-# 
+#
 msgid ""
 msgstr ""
 

src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po

@@ -2,11 +2,11 @@
 # Copyright (C) 2024 ORGANIZATION
 # This file is distributed under the same license as the PROJECT project.
 # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
-# 
+#
 # Translators:
 # Rambaud Pierrick <[email protected]>, 2024
 # Denis Bitouzé <[email protected]>, 2024
-# 
+#
 msgid ""
 msgstr ""
 

src/pydata_sphinx_theme/locale/it/LC_MESSAGES/sphinx.po

@@ -183,4 +183,3 @@ msgstr "Navigazione del sito"
 
 #~ msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
 #~ msgstr "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
-

src/pydata_sphinx_theme/locale/ja/LC_MESSAGES/sphinx.po

@@ -185,4 +185,3 @@ msgstr "サイトナビゲーション"
 
 #~ msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
 #~ msgstr "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
-

src/pydata_sphinx_theme/locale/ru/LC_MESSAGES/sphinx.po

@@ -180,4 +180,3 @@ msgstr "Навигация по сайту"
 
 #~ msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
 #~ msgstr "© <a href=\\\"%(path)s\\\">Копирайт</a> %(copyright)s."
-

src/pydata_sphinx_theme/locale/sphinx.pot

@@ -169,4 +169,3 @@ msgstr ""
 #: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:3
 msgid "Site navigation"
 msgstr ""
-

src/pydata_sphinx_theme/locale/zh/LC_MESSAGES/sphinx.po

@@ -183,4 +183,3 @@ msgstr "网页导航"
 
 #~ msgid "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
 #~ msgstr "© <a href=\"%(path)s\">Copyright</a> %(copyright)s."
-

src/pydata_sphinx_theme/logo.py

@@ -56,9 +56,11 @@ def setup_logo_path(
 
 
 def copy_logo_images(app: Sphinx, exception=None) -> None:
-    """Copy logo image to the _static directory.
+    """
+    Copy logo image to the _static directory.
 
-    If logo image paths are given, copy them to the `_static` folder Then we can link to them directly in an html_page_context event.
+    If logo image paths are given, copy them to the `_static` folder.
+    Then we can link to them directly in an html_page_context event.
     """
     warning = partial(maybe_warn, app)
     logo = get_theme_options_dict(app).get("logo", {})
@@ -76,7 +78,8 @@ def copy_logo_images(app: Sphinx, exception=None) -> None:
         assert full_logo_path.is_absolute()
         if not full_logo_path.exists():
             warning(f"Path to {kind} image logo does not exist: {path_image}")
-        # Ensure templates cannot be passed for logo path to avoid security vulnerability
+        # Ensure templates cannot be passed for logo path to avoid security
+        # vulnerability
         if path_image.lower().endswith("_t"):
             raise ExtensionError(
                 f"The {kind} logo path '{path_image}' looks like a Sphinx template; "

src/pydata_sphinx_theme/short_link.py

@@ -11,20 +11,24 @@
 
 
 class ShortenLinkTransform(SphinxPostTransform):
-    """Shorten link when they are coming from github or gitlab and add an extra class to the tag for further styling.
+    """
+    Shorten link when they are coming from github or gitlab and add an extra class to
+    the tag for further styling.
 
     Before:
         .. code-block:: html
 
-            <a class="reference external" href="https://github.com/2i2c-org/infrastructure/issues/1329">
-              https://github.com/2i2c-org/infrastructure/issues/1329
+            <a class="reference external"
+                href="https://github.com/2i2c-org/infrastructure/issues/1329">
+                https://github.com/2i2c-org/infrastructure/issues/1329
             </a>
 
     After:
         .. code-block:: html
 
-            <a class="reference external github" href="https://github.com/2i2c-org/infrastructure/issues/1329">
-               2i2c-org/infrastructure#1329
+            <a class="reference external github"
+                href="https://github.com/2i2c-org/infrastructure/issues/1329">
+                2i2c-org/infrastructure#1329
             </a>
     """
 

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/search-button-field.html

@@ -1,5 +1,5 @@
 {# Displays a search field image that opens a search overlay when clicked. #}
-{# 
+{#
     As this function will only work when JavaScript is enabled,
     we add a class that will hide it if js is disable.
 #}