From 3e78528cc8025d93dc2ccd25cafb07ed85a331dd Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Wed, 6 Sep 2023 10:57:25 +0300
Subject: [PATCH 01/23] Fix duplicate HTML IDs

---
 .../components/navbar-nav.html                | 10 ++++++-
 .../components/version-switcher.html          | 26 +++++++++++++----
 .../pydata_sphinx_theme/sections/header.html  |  4 +++
 .../sections/sidebar-primary.html             |  4 +++
 src/pydata_sphinx_theme/toctree.py            | 28 ++++++++++++++++---
 5 files changed, 61 insertions(+), 11 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
index 7678a152d..0eeaf4934 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
@@ -1,3 +1,9 @@
+{% set base_id = "pst-more-nav-links" %}
+{% if parent_template_name %}
+  {% set dropdown_id = create_next_id(base_id + "-in-" + parent_template_name) %}
+{% else %}
+  {% set dropdown_id = create_next_id(base_id) %}
+{% endif %}
 <nav class="navbar-nav">
   <p class="sidebar-header-items__title"
      role="heading"
@@ -6,6 +12,8 @@
     {{ _("Site Navigation") }}
   </p>
   <ul class="bd-navbar-elements navbar-nav">
-    {{ generate_header_nav_html(n_links_before_dropdown=theme_header_links_before_dropdown) }}
+    {{ generate_header_nav_html(
+        dropdown_id,
+        n_links_before_dropdown=theme_header_links_before_dropdown) }}
   </ul>
 </nav>
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
index 974aa8c87..bde1a4437 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
@@ -1,14 +1,28 @@
-{# As the version switcher will only work when JavaScript is enabled, we add it through JavaScript.
- #}
+{# As the version switcher will only work when JavaScript is enabled, we add it through JavaScript. #}
+{% set base_button_id = "pst-version-switcher-button" %}
+{% set base_dropdown_id = "pst-version-switcher-list" %}
+{% if parent_template_name %}
+  {% set button_id = create_next_id(base_button_id + "-in-" + parent_template_name) %}
+  {% set dropdown_id = create_next_id(base_dropdown_id + "-in-" + parent_template_name) %}
+{% else %}
+  {% set button_id = create_next_id(base_button_id) %}
+  {% set dropdown_id = create_next_id(base_dropdown_id) %}
+{% endif %}
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
-    <button id="versionswitcherbutton" type="button" role="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="versionswitcherlist" aria-label="Version switcher list">
-      {{ theme_switcher.get('version_match') }}  <!-- this text may get changed later by javascript -->
+    <button id="{{ button_id }}" type="button" role="button"
+      class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
+      data-bs-toggle="dropdown" aria-haspopup="listbox"
+      aria-controls="{{ dropdown_id }}" aria-label="Version switcher list">
+      <!-- this text may get changed later by javascript -->
+      {{ theme_switcher.get('version_match') }}
       <span class="caret"></span>
     </button>
-    <div id="versionswitcherlist" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="versionswitcherbutton">
-    <!-- dropdown will be populated by javascript on page load -->
+    <div id="{{ dropdown_id }}"
+      class="version-switcher__menu dropdown-menu list-group-flush py-0"
+      role="listbox" aria-labelledby="{{ button_id }}">
+      <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>
 `);
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html
index 01744a812..1376a523c 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html
@@ -1,3 +1,7 @@
+{# Set parent_template_name as a way for child templates included by this
+template to access the template name. This can be used, for example, when
+generating HTML IDs #}
+{% set parent_template_name = "header" %}
 {% if theme_navbar_start or theme_navbar_center or theme_navbar_end or theme_navbar_persistent %}
 <div class="bd-header__inner bd-page-width">
   <label class="sidebar-toggle primary-toggle" for="__primary">
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html
index af21e502d..629d05fc0 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html
@@ -1,4 +1,8 @@
 {% block docs_sidebar %}
+{# Set parent_template_name as a way for child templates included by this
+  template to access the template name. This can be used, for example, when
+  generating HTML IDs #}
+{% set parent_template_name = "sidebar-primary" %}
 {% if theme_navbar_center or theme_navbar_end or sidebars or theme_primary_sidebar_end %}
   {# Header items that will be displayed in the sidebar on mobile #}
   <div class="sidebar-header-items sidebar-primary__section">
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 0ddbf9feb..90c85cc26 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -1,7 +1,8 @@
 """Methods to build the toctree used in the html pages."""
 
 from functools import lru_cache
-from typing import List, Union
+from itertools import count
+from typing import Generator, List, Union
 from urllib.parse import urlparse
 
 import sphinx
@@ -36,7 +37,25 @@ def add_toctree_functions(
     """Add functions so Jinja templates can add toctree objects."""
 
     @lru_cache(maxsize=None)
-    def generate_header_nav_html(n_links_before_dropdown: int = 5) -> str:
+    def get_id_generator(base_id: str) -> Generator[str]:
+        for n in count(start=1):
+            if n == 1:
+                yield base_id
+            else:
+                yield f"{base_id}-{n}"
+
+    def create_next_id(base_id: str):
+        """Create an id that is build-time unique.
+
+        The function works by sequentially returning "<base_id>", "<base_id>-2",
+        "<base_id>-3", etc. each time it is called.
+        """
+        return next(get_id_generator(base_id))
+
+    @lru_cache(maxsize=None)
+    def generate_header_nav_html(
+        dropdown_id: str, n_links_before_dropdown: int = 5
+    ) -> str:
         """Generate top-level links that are meant for the header navigation.
 
         We use this function instead of the TocTree-based one used for the
@@ -148,10 +167,10 @@ def generate_header_nav_html(n_links_before_dropdown: int = 5) -> str:
             links_dropdown_html = "\n".join(links_dropdown)
             out += f"""
             <li class="nav-item dropdown">
-                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-header-nav-more-links">
+                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="{dropdown_id}">
                     More
                 </button>
-                <ul id="pst-header-nav-more-links" class="dropdown-menu">
+                <ul id="{dropdown_id}" class="dropdown-menu">
                     {links_dropdown_html}
                 </ul>
             </li>
@@ -310,6 +329,7 @@ def navbar_align_class() -> List[str]:
             )
         return align_options[align]
 
+    context["create_next_id"] = create_next_id
     context["generate_header_nav_html"] = generate_header_nav_html
     context["generate_toctree_html"] = generate_toctree_html
     context["generate_toc_html"] = generate_toc_html

From 78b3aac1384e8d698d6706e1af93dfe999808e1f Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Wed, 6 Sep 2023 12:48:00 +0300
Subject: [PATCH 02/23] fix tests

---
 src/pydata_sphinx_theme/toctree.py    |  4 ++--
 tests/test_build/navbar_switcher.html | 14 ++++++++++----
 2 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 90c85cc26..17003c30c 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -2,7 +2,7 @@
 
 from functools import lru_cache
 from itertools import count
-from typing import Generator, List, Union
+from typing import Iterator, List, Union
 from urllib.parse import urlparse
 
 import sphinx
@@ -37,7 +37,7 @@ def add_toctree_functions(
     """Add functions so Jinja templates can add toctree objects."""
 
     @lru_cache(maxsize=None)
-    def get_id_generator(base_id: str) -> Generator[str]:
+    def get_id_generator(base_id: str) -> Iterator[str]:
         for n in count(start=1):
             if n == 1:
                 yield base_id
diff --git a/tests/test_build/navbar_switcher.html b/tests/test_build/navbar_switcher.html
index dd08c7f63..bf04b7db2 100644
--- a/tests/test_build/navbar_switcher.html
+++ b/tests/test_build/navbar_switcher.html
@@ -1,12 +1,18 @@
 <script>
  document.write(`
   <div class="version-switcher__container dropdown">
-    <button id="versionswitcherbutton" type="button" role="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-bs-toggle="dropdown" aria-haspopup="listbox" aria-controls="versionswitcherlist" aria-label="Version switcher list">
-      0.7.1  <!-- this text may get changed later by javascript -->
+    <button id="pst-version-switcher-button-in-header" type="button" role="button"
+      class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
+      data-bs-toggle="dropdown" aria-haspopup="listbox"
+      aria-controls="pst-version-switcher-list-in-header" aria-label="Version switcher list">
+      <!-- this text may get changed later by javascript -->
+      0.7.1
       <span class="caret"></span>
     </button>
-    <div id="versionswitcherlist" class="version-switcher__menu dropdown-menu list-group-flush py-0" role="listbox" aria-labelledby="versionswitcherbutton">
-    <!-- dropdown will be populated by javascript on page load -->
+    <div id="pst-version-switcher-list-in-header"
+      class="version-switcher__menu dropdown-menu list-group-flush py-0"
+      role="listbox" aria-labelledby="pst-version-switcher-button-in-header">
+      <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>
 `);

From 0de959923fb3b827c6a0057c06b811c990b04e28 Mon Sep 17 00:00:00 2001
From: gabalafou <gabriel@fouasnon.com>
Date: Wed, 6 Sep 2023 18:32:26 +0300
Subject: [PATCH 03/23] Do not animate the version admonitions colors. (#1424)

Otherwise a delay has to be added to the accessibility color
contrast checks, to wait for the colors to fully transition.
---
 .../assets/styles/components/_versionmodified.scss               | 1 -
 1 file changed, 1 deletion(-)

diff --git a/src/pydata_sphinx_theme/assets/styles/components/_versionmodified.scss b/src/pydata_sphinx_theme/assets/styles/components/_versionmodified.scss
index c0174633b..1e810e909 100644
--- a/src/pydata_sphinx_theme/assets/styles/components/_versionmodified.scss
+++ b/src/pydata_sphinx_theme/assets/styles/components/_versionmodified.scss
@@ -9,7 +9,6 @@ div.deprecated {
   border-left: 0.2rem solid;
   border-color: var(--pst-color-info);
   border-radius: $admonition-border-radius;
-  transition: color 250ms, background-color 250ms, border-color 250ms;
   background-color: var(--pst-color-on-background);
   @include box-shadow();
   position: relative;

From 8f6e5b46e21d258c28b96a119f5e588780ed6036 Mon Sep 17 00:00:00 2001
From: gabalafou <gabriel@fouasnon.com>
Date: Wed, 6 Sep 2023 19:25:04 +0300
Subject: [PATCH 04/23] BUG - Remove redundant ARIA in breadcrumb navigation
 (#1426)

---
 .../theme/pydata_sphinx_theme/components/breadcrumbs.html     | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html
index d5c73b7de..2d7261c6b 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html
@@ -9,8 +9,8 @@
 
 {#- Hide breadcrumbs on the home page #}
 {% if title and pagename != root_doc %}
-<nav aria-label="{{ _('Breadcrumbs') }}">
-  <ul class="bd-breadcrumbs" role="navigation" aria-label="{{ _('Breadcrumb') }}">
+<nav aria-label="{{ _('Breadcrumb') }}">
+  <ul class="bd-breadcrumbs">
     {# Home icon #}
     <li class="breadcrumb-item breadcrumb-home">
       <a href="{{ pathto(root_doc) }}" class="nav-link" aria-label="{{ _('Home') }}">

From ff23b3a8c9eb2230384a2a8c79f0bd35f7af6929 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Denis=20Bitouz=C3=A9?= <dbitouze@wanadoo.fr>
Date: Fri, 8 Sep 2023 17:36:29 +0200
Subject: [PATCH 05/23] style(i18n): French Typo fixed (#1430)

---
 src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po b/src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po
index 88bb44ecf..a26bd626d 100644
--- a/src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po
+++ b/src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po
@@ -48,7 +48,7 @@ msgstr "Fil d'Ariane"
 
 #: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html:16
 msgid "Home"
-msgstr "Acceuil"
+msgstr "Accueil"
 
 #: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/copyright.html:4
 #, python-format

From edd5902e17aadfc76c2a38c0e8b7cddfb3427504 Mon Sep 17 00:00:00 2001
From: Stuart Mumford <stuart@cadair.com>
Date: Fri, 8 Sep 2023 23:30:32 +0100
Subject: [PATCH 06/23] Add the ability to add a center section to the footer
 (#1432)

* Add a center section for the footer

* Add docs for footer_center

* Add a test site for the center footer

* test it in our own docs

* remove new test site

* add footer test

---------

Co-authored-by: Daniel McCloy <dan@mccloy.info>
---
 docs/conf.py                                     |  3 ++-
 docs/user_guide/layout.rst                       |  4 ++--
 src/pydata_sphinx_theme/__init__.py              |  1 +
 .../assets/styles/sections/_footer.scss          |  7 ++++++-
 .../pydata_sphinx_theme/sections/footer.html     |  7 +++++++
 .../theme/pydata_sphinx_theme/theme.conf         |  1 +
 tests/test_build.py                              | 16 ++++++++++++++++
 7 files changed, 35 insertions(+), 4 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 986b4ba4e..77bedc9a2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -174,7 +174,8 @@
     # "primary_sidebar_end": ["custom-template.html", "sidebar-ethical-ads.html"],
     # "article_footer_items": ["test.html", "test.html"],
     # "content_footer_items": ["test.html", "test.html"],
-    # "footer_start": ["test.html", "test.html"],
+    "footer_start": ["copyright.html"],
+    "footer_center": ["sphinx-version.html"],
     # "secondary_sidebar_items": ["page-toc.html"],  # Remove the source buttons
     "switcher": {
         "json_url": json_url,
diff --git a/docs/user_guide/layout.rst b/docs/user_guide/layout.rst
index ee822eb40..a562f9d8c 100644
--- a/docs/user_guide/layout.rst
+++ b/docs/user_guide/layout.rst
@@ -488,9 +488,9 @@ Footer
 Located in ``sections/footer.html``.
 
 The footer is just below a page's main content, and is configured in ``conf.py``
-with ``html_theme_options['footer_start']`` and ``html_theme_options['footer_end']``.
+with ``html_theme_options['footer_start']``, ``html_theme_options['footer_center']`` and ``html_theme_options['footer_end']``.
 
-By default, ``footer_end`` is empty, and ``footer_start`` has the following templates:
+By default, ``footer_center`` is empty, and ``footer_start`` and ``footer_end`` have the following templates:
 
 .. code-block:: python
 
diff --git a/src/pydata_sphinx_theme/__init__.py b/src/pydata_sphinx_theme/__init__.py
index 146da7fc8..6af8a38c2 100644
--- a/src/pydata_sphinx_theme/__init__.py
+++ b/src/pydata_sphinx_theme/__init__.py
@@ -190,6 +190,7 @@ def update_and_remove_templates(
         "theme_article_footer_items",
         "theme_content_footer_items",
         "theme_footer_start",
+        "theme_footer_center",
         "theme_footer_end",
         "theme_secondary_sidebar_items",
         "theme_primary_sidebar_end",
diff --git a/src/pydata_sphinx_theme/assets/styles/sections/_footer.scss b/src/pydata_sphinx_theme/assets/styles/sections/_footer.scss
index ce79172d0..86484733c 100644
--- a/src/pydata_sphinx_theme/assets/styles/sections/_footer.scss
+++ b/src/pydata_sphinx_theme/assets/styles/sections/_footer.scss
@@ -10,15 +10,20 @@
   }
 
   .footer-items__start,
+  .footer-items__center,
   .footer-items__end {
     display: flex;
     flex-direction: column;
     gap: 0.5rem;
     justify-content: center;
+    flex-grow: 1;
+  }
+
+  .footer-items__center {
+    text-align: center;
   }
 
   .footer-items__end {
-    margin-left: auto;
     text-align: end;
   }
 
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html
index fb845596d..691cd5f6d 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html
@@ -7,6 +7,13 @@
       {% endfor %}
     </div>
   {% endif %}
+  {% if theme_footer_center %}
+    <div class="footer-items__center">
+      {% for item in theme_footer_center %}
+        <div class="footer-item">{% include item %}</div>
+      {% endfor %}
+    </div>
+  {% endif %}
   {% if theme_footer_end %}
     <div class="footer-items__end">
       {% for item in theme_footer_end %}
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
index 0b2685086..97598c547 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
@@ -47,6 +47,7 @@ article_footer_items =
 content_footer_items =
 primary_sidebar_end = sidebar-ethical-ads.html
 footer_start = copyright.html, sphinx-version.html
+footer_center =
 footer_end = theme-version.html
 secondary_sidebar_items = page-toc.html, edit-this-page.html, sourcelink.html
 show_version_warning_banner = False
diff --git a/tests/test_build.py b/tests/test_build.py
index e2fa91457..ca3a9d262 100644
--- a/tests/test_build.py
+++ b/tests/test_build.py
@@ -418,6 +418,22 @@ def test_included_toc(sphinx_build_factory) -> None:
     assert included_page_html is not None
 
 
+def test_footer(sphinx_build_factory) -> None:
+    """Test for expected footer contents."""
+    overrides = {
+        "html_theme_options.footer_start": ["copyright.html"],
+        "html_theme_options.footer_center": ["sphinx-version.html"],
+    }
+    sphinx_build = sphinx_build_factory("base", confoverrides=overrides).build()
+    index_html = sphinx_build.html_tree("index.html")
+    footer_sta = index_html.select("div.footer-items__start")[0]
+    footer_ctr = index_html.select("div.footer-items__center")[0]
+    footer_end = index_html.select("div.footer-items__end")[0]
+    assert "Pydata community" in footer_sta.text
+    assert "Created using" in footer_ctr.text
+    assert "Built with the" in footer_end.text
+
+
 # html contexts for `show_edit_button`
 
 # these are "good" context fragments that should yield a working link

From 0125510cacf54ca486c71d67c61e1e26f8a1123b Mon Sep 17 00:00:00 2001
From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 11 Sep 2023 10:54:57 +0200
Subject: [PATCH 07/23] Build(deps): Bump actions/checkout from 3 to 4 (#1433)

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
---
 .github/workflows/prerelease.yml |  2 +-
 .github/workflows/publish.yml    |  2 +-
 .github/workflows/tests.yml      | 10 +++++-----
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml
index 41f96dc63..7d9b8ea06 100644
--- a/.github/workflows/prerelease.yml
+++ b/.github/workflows/prerelease.yml
@@ -16,7 +16,7 @@ jobs:
         python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 442dfcd97..7bee7191e 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index f2873fc53..b1d514cc8 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -31,7 +31,7 @@ jobs:
         python-version: ["3.11"]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
@@ -70,7 +70,7 @@ jobs:
       SPHINX_VERSION: ${{ matrix.sphinx-version }}
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
@@ -136,7 +136,7 @@ jobs:
       SPHINX_VERSION: ${{ matrix.sphinx-version }}
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
@@ -162,7 +162,7 @@ jobs:
         python-version: ["3.11"]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
@@ -205,7 +205,7 @@ jobs:
         python-version: ["3.11"]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
         uses: actions/setup-python@v4
         with:

From 402788fb0c43324e620af4a727eb6795ec1a782f Mon Sep 17 00:00:00 2001
From: Alenka Frim <AlenkaF@users.noreply.github.com>
Date: Thu, 14 Sep 2023 23:54:53 +0200
Subject: [PATCH 08/23] Add dropdown_text argument to generate_header_nav_html
 (#1423)

* Add dropdown_text argument to generate_header_nav_html

* Add a test, fix typo in theme.conf and remove header_dropdown_text from docs/conf.py

* fixed?

---------

Co-authored-by: Daniel McCloy <dan@mccloy.info>
---
 .../components/navbar-nav.html                |  4 +--
 .../theme/pydata_sphinx_theme/theme.conf      |  1 +
 src/pydata_sphinx_theme/toctree.py            |  6 ++--
 tests/test_build.py                           | 28 +++++++++++++++++++
 4 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
index 0eeaf4934..710d513a8 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
@@ -12,8 +12,6 @@
     {{ _("Site Navigation") }}
   </p>
   <ul class="bd-navbar-elements navbar-nav">
-    {{ generate_header_nav_html(
-        dropdown_id,
-        n_links_before_dropdown=theme_header_links_before_dropdown) }}
+    {{ generate_header_nav_html(n_links_before_dropdown=theme_header_links_before_dropdown, dropdown_text=theme_header_dropdown_text) }}
   </ul>
 </nav>
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
index 97598c547..3124424fd 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf
@@ -30,6 +30,7 @@ show_nav_level = 1
 show_toc_level = 1
 navbar_align = content
 header_links_before_dropdown = 5
+header_dropdown_text = More
 switcher =
 check_switcher = True
 pygment_light_style = a11y-high-contrast-light
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 17003c30c..e4a62bd8d 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -13,6 +13,7 @@
 from sphinx.addnodes import toctree as toctree_node
 from sphinx.application import Sphinx
 from sphinx.environment.adapters.toctree import TocTree
+from sphinx.locale import _
 
 from .utils import traverse_or_findall
 
@@ -54,7 +55,7 @@ def create_next_id(base_id: str):
 
     @lru_cache(maxsize=None)
     def generate_header_nav_html(
-        dropdown_id: str, n_links_before_dropdown: int = 5
+        n_links_before_dropdown: int = 5, dropdown_text: str = "More"
     ) -> str:
         """Generate top-level links that are meant for the header navigation.
 
@@ -72,6 +73,7 @@ def generate_header_nav_html(
 
         Parameters:
             n_links_before_dropdown:The number of links to show before nesting the remaining links in a Dropdown element.
+            dropdown_text:Text of the dropdown element button.
         """
         try:
             n_links_before_dropdown = int(n_links_before_dropdown)
@@ -168,7 +170,7 @@ def generate_header_nav_html(
             out += f"""
             <li class="nav-item dropdown">
                 <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="{dropdown_id}">
-                    More
+                    {_(dropdown_text)}
                 </button>
                 <ul id="{dropdown_id}" class="dropdown-menu">
                     {links_dropdown_html}
diff --git a/tests/test_build.py b/tests/test_build.py
index ca3a9d262..6cfc37d07 100644
--- a/tests/test_build.py
+++ b/tests/test_build.py
@@ -333,6 +333,34 @@ def test_navbar_header_dropdown(sphinx_build_factory, n_links) -> None:
         assert standalone_links and not dropdowns
 
 
+@pytest.mark.parametrize("dropdown_text", (None, "Other"))  # None -> default "More"
+def test_navbar_header_dropdown_button(sphinx_build_factory, dropdown_text) -> None:
+    """Test whether dropdown button text is configurable."""
+    if dropdown_text:
+        confoverrides = {
+            "html_theme_options": {
+                "header_links_before_dropdown": 2,
+                "header_dropdown_text": dropdown_text,
+            }
+        }
+    else:
+        confoverrides = {
+            "html_theme_options": {
+                "header_links_before_dropdown": 2,
+            }
+        }
+    sphinx_build = sphinx_build_factory("base", confoverrides=confoverrides).build()
+    index_html = sphinx_build.html_tree("index.html")
+    navbar = index_html.select("ul.bd-navbar-elements")[0]
+    button_text = str(navbar.select("button")[0])
+    if dropdown_text:
+        # The dropdown text should be "Other"
+        assert dropdown_text in button_text
+    else:
+        # The dropdown text should be "More"
+        assert "More" in button_text
+
+
 def test_sidebars_captions(sphinx_build_factory, file_regression) -> None:
     """Test that the captions are rendered."""
     sphinx_build = sphinx_build_factory("sidebars").build()

From b46475f87c1169f6524e6ea86ae02b0a31781dd8 Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Fri, 15 Sep 2023 07:55:35 +0200
Subject: [PATCH 09/23] fix: rollback ref and Id changes (#1438)

---
 src/pydata_sphinx_theme/translator.py | 90 ---------------------------
 1 file changed, 90 deletions(-)

diff --git a/src/pydata_sphinx_theme/translator.py b/src/pydata_sphinx_theme/translator.py
index 8c8eda4ee..eb2046bd4 100644
--- a/src/pydata_sphinx_theme/translator.py
+++ b/src/pydata_sphinx_theme/translator.py
@@ -1,17 +1,13 @@
 """A custom Sphinx HTML Translator for Bootstrap layout."""
 
 import types
-from functools import partial
 
 import sphinx
-from docutils.nodes import Element
 from packaging.version import Version
 from sphinx.application import Sphinx
 from sphinx.ext.autosummary import autosummary_table
 from sphinx.util import logging
 
-from .utils import traverse_or_findall
-
 logger = logging.getLogger(__name__)
 
 
@@ -63,92 +59,6 @@ def visit_table(self, node):
         tag = self.starttag(node, "table", CLASS=" ".join(classes), **atts)
         self.body.append(tag)
 
-    # NOTE: `visit_section`, `visit_desc_signature` & `visit_reference` are extended
-    # here to resolve #1026 & #1207. There is an open issue with Sphinx to address this:
-    # https://github.com/sphinx-doc/sphinx/issues/11208
-    # If the issue is resolved within Sphinx, these methods can be removed.
-
-    def visit_section(self, node):
-        """Handle section nodes to replace dots with underscores.
-
-        This will modify the ``id`` of HTML ``<section>`` tags, where Python modules
-        are documented. Replacing dots with underscores allows the tags to be recognized
-        as navigation targets by ScrollSpy.
-        """
-        if "ids" in node:
-            node["ids"] = [id_.replace(".", "_") for id_ in node["ids"]]
-        super().visit_section(node)
-
-    def visit_desc_signature(self, node):
-        """Handle function & method signature nodes to replace dots with underscores.
-
-        This will modify the ``id`` attribute of HTML ``<dt>`` & ``<dd>`` tags, where
-        Python functions are documented. Replacing dots with underscores allows the tags
-        to be recognized as navigation targets by ScrollSpy.
-        """
-        if "ids" in node:
-            ids = node["ids"]
-            for i, id_ in enumerate(ids):
-                ids[i] = id_.replace(".", "_")
-        super().visit_desc_signature(node)
-
-    def visit_reference(self, node):
-        """Handle reference nodes to replace dots with underscores.
-
-        This will modify the ``href`` attribute of any internal HTML ``<a>`` tags, e.g.
-        the sidebar navigation links.
-        """
-        try:
-            # We are only interested in internal anchor references
-            internal, anchorname = node["internal"], node["anchorname"]
-            if internal and anchorname.startswith("#") and "." in anchorname:
-                # Get the root node of the current document
-                document = self.builder.env.get_doctree(self.builder.current_docname)
-
-                # Get the target anchor ID
-                target_id = anchorname.lstrip("#")
-                sanitized_id = target_id.replace(".", "_")
-                # Update the node `href`
-                node["refuri"] = node["anchorname"] = "#" + sanitized_id
-
-                # Define a search condition to find the target node by ID
-                def find_target(search_id, node):
-                    return (
-                        isinstance(node, Element)
-                        and ("ids" in node)
-                        and (search_id in node["ids"])
-                    )
-
-                # NOTE: Replacing with underscores creates the possibility for
-                # conflicting references. Here we check for these and warn the
-                # user if any are found.
-                if any(
-                    traverse_or_findall(
-                        document, condition=partial(find_target, sanitized_id)
-                    )
-                ):
-                    logger.warning(
-                        f'Sanitized reference "{sanitized_id}" for "{target_id}" '
-                        "conflicts with an existing reference!"
-                    )
-
-                # Find nodes with the given ID (there should only be one)
-                targets = traverse_or_findall(
-                    document, condition=partial(find_target, target_id)
-                )
-                # Replace dots with underscores in the target node ID
-                for target in targets:
-                    # NOTE: By itself, modifying the target `ids` here seems to be
-                    # insufficient, however it helps ensure that the reference `refuri`
-                    # and target `ids` remain consistent during the build process
-                    target["ids"] = [
-                        sanitized_id if id_ == target_id else id_
-                        for id_ in target["ids"]
-                    ]
-        except KeyError:
-            pass
-        super().visit_reference(node)
-
 
 def setup_translators(app: Sphinx):
     """Add bootstrap HTML functionality if we are using an HTML translator.

From 8a80214e7d5ded79489ed6f48569d079e99acb86 Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Fri, 15 Sep 2023 08:05:14 +0200
Subject: [PATCH 10/23] =?UTF-8?q?bump:=20version=200.13.3=20=E2=86=92=200.?=
 =?UTF-8?q?14.0=20=20(#1440)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* bump version

* update version switcher
---
 docs/_static/switcher.json          | 14 +++++++-------
 src/pydata_sphinx_theme/__init__.py |  2 +-
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json
index 6d4f0a912..e25c7fff9 100644
--- a/docs/_static/switcher.json
+++ b/docs/_static/switcher.json
@@ -4,11 +4,16 @@
     "url": "https://pydata-sphinx-theme.readthedocs.io/en/latest/"
   },
   {
-    "name": "0.13.3 (stable)",
-    "version": "v0.13.3",
+    "name": "0.14.0 (stable)",
+    "version": "v0.14.0",
     "url": "https://pydata-sphinx-theme.readthedocs.io/en/stable/",
     "preferred": true
   },
+  {
+    "name": "0.13.3",
+    "version": "v0.13.3",
+    "url": "https://pydata-sphinx-theme.readthedocs.io/en/v0.13.3/"
+  },
   {
     "name": "0.12.0",
     "version": "v0.12.0",
@@ -23,10 +28,5 @@
     "name": "0.10.1",
     "version": "v0.10.1",
     "url": "https://pydata-sphinx-theme.readthedocs.io/en/v0.10.1/"
-  },
-  {
-    "name": "0.9.0",
-    "version": "v0.9.0",
-    "url": "https://pydata-sphinx-theme.readthedocs.io/en/v0.9.0/"
   }
 ]
diff --git a/src/pydata_sphinx_theme/__init__.py b/src/pydata_sphinx_theme/__init__.py
index 6af8a38c2..904270422 100644
--- a/src/pydata_sphinx_theme/__init__.py
+++ b/src/pydata_sphinx_theme/__init__.py
@@ -14,7 +14,7 @@
 
 from . import edit_this_page, logo, pygment, short_link, toctree, translator, utils
 
-__version__ = "0.13.4dev0"
+__version__ = "0.14.0"
 
 logger = logging.getLogger(__name__)
 

From a4e28043b59b2df004f60bea4038a36aa109db9d Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Fri, 15 Sep 2023 08:52:48 +0200
Subject: [PATCH 11/23] back to dev

---
 src/pydata_sphinx_theme/__init__.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/pydata_sphinx_theme/__init__.py b/src/pydata_sphinx_theme/__init__.py
index 904270422..c92e14168 100644
--- a/src/pydata_sphinx_theme/__init__.py
+++ b/src/pydata_sphinx_theme/__init__.py
@@ -14,7 +14,7 @@
 
 from . import edit_this_page, logo, pygment, short_link, toctree, translator, utils
 
-__version__ = "0.14.0"
+__version__ = "0.14.1dev0"
 
 logger = logging.getLogger(__name__)
 

From 68c57ed1d751f057233f768439b58e96a57c1bfe Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Fri, 15 Sep 2023 15:50:00 +0200
Subject: [PATCH 12/23] fix: change the z-index of the dropdown (#1442)

In order to be on top of the primary sidebar on small screens.
---
 .../assets/styles/components/_switcher-version.scss              | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/pydata_sphinx_theme/assets/styles/components/_switcher-version.scss b/src/pydata_sphinx_theme/assets/styles/components/_switcher-version.scss
index 2d152b952..84baed7a7 100644
--- a/src/pydata_sphinx_theme/assets/styles/components/_switcher-version.scss
+++ b/src/pydata_sphinx_theme/assets/styles/components/_switcher-version.scss
@@ -53,6 +53,7 @@ button.btn.version-switcher__button {
 button.version-switcher__button,
 .version-switcher__menu {
   font-size: 1.1em; // A bit smaller than other menu font
+  z-index: $zindex-modal; // higher than the sidebars
   @include media-breakpoint-up($breakpoint-sidebar-primary) {
     font-size: unset;
   }

From 19dfb69510d705f7bbeb17c43ed4a0bedab648eb Mon Sep 17 00:00:00 2001
From: Rambaud Pierrick <12rambau@users.noreply.github.com>
Date: Fri, 15 Sep 2023 16:39:07 +0200
Subject: [PATCH 13/23] fix: set the same background for dark/light (#1443)

* fix: set the same background for dark/light
et the same background color for all state of the search field. It is currently only applied when hovered

* fix: wrong css selector

* Update src/pydata_sphinx_theme/assets/styles/components/_search.scss

* Update src/pydata_sphinx_theme/assets/styles/components/_search.scss
---
 src/pydata_sphinx_theme/assets/styles/components/_search.scss | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/pydata_sphinx_theme/assets/styles/components/_search.scss b/src/pydata_sphinx_theme/assets/styles/components/_search.scss
index d40894d51..8fffcb0d1 100644
--- a/src/pydata_sphinx_theme/assets/styles/components/_search.scss
+++ b/src/pydata_sphinx_theme/assets/styles/components/_search.scss
@@ -52,6 +52,8 @@
 }
 
 .form-control {
+  background-color: var(--pst-color-background);
+
   &:focus,
   &:focus-visible {
     border: none;
@@ -139,9 +141,9 @@
   border-radius: 1.5em;
   color: var(--pst-color-text-muted);
   padding: 0.5em;
+  background-color: var(--pst-color-surface);
 
   &:hover {
-    background-color: var(--pst-color-surface);
     border: 2px solid var(--pst-color-link-hover);
   }
   &:focus-visible {

From a664e4aa3aecb3040a7e09b9d1d792375ae04197 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Wed, 6 Sep 2023 10:57:25 +0300
Subject: [PATCH 14/23] Fix duplicate HTML IDs

---
 .../components/navbar-nav.html                  |  5 ++++-
 src/pydata_sphinx_theme/toctree.py              | 17 ++++++++++++++++-
 2 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
index 710d513a8..18912067f 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
@@ -12,6 +12,9 @@
     {{ _("Site Navigation") }}
   </p>
   <ul class="bd-navbar-elements navbar-nav">
-    {{ generate_header_nav_html(n_links_before_dropdown=theme_header_links_before_dropdown, dropdown_text=theme_header_dropdown_text) }}
+    {{ generate_header_nav_html(
+        dropdown_id,
+        n_links_before_dropdown=theme_header_links_before_dropdown,
+        dropdown_text=theme_header_dropdown_text) }}
   </ul>
 </nav>
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index e4a62bd8d..0b2ee80c6 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -37,6 +37,21 @@ def add_toctree_functions(
 ) -> None:
     """Add functions so Jinja templates can add toctree objects."""
 
+    def get_id_generator(base_id: str) -> Generator[str]:
+        for n in count(start=1):
+            if n == 1:
+                yield base_id
+            else:
+                yield f"{base_id}-{n}"
+
+    def create_next_id(base_id: str):
+        """Create an id that is build-time unique.
+
+        The function works by sequentially returning "<base_id>", "<base_id>-2",
+        "<base_id>-3", etc. each time it is called.
+        """
+        return next(get_id_generator(base_id))
+
     @lru_cache(maxsize=None)
     def get_id_generator(base_id: str) -> Iterator[str]:
         for n in count(start=1):
@@ -55,7 +70,7 @@ def create_next_id(base_id: str):
 
     @lru_cache(maxsize=None)
     def generate_header_nav_html(
-        n_links_before_dropdown: int = 5, dropdown_text: str = "More"
+        n_links_before_dropdown: int = 5, dropdown_text: str = "More", dropdown_id: str = None
     ) -> str:
         """Generate top-level links that are meant for the header navigation.
 

From ba479ddeb1498e024a6120dcc5e232fdda4cb86e Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Wed, 6 Sep 2023 12:48:00 +0300
Subject: [PATCH 15/23] fix tests

---
 src/pydata_sphinx_theme/toctree.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 0b2ee80c6..de90dc3ee 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -37,7 +37,8 @@ def add_toctree_functions(
 ) -> None:
     """Add functions so Jinja templates can add toctree objects."""
 
-    def get_id_generator(base_id: str) -> Generator[str]:
+    @lru_cache(maxsize=None)
+    def get_id_generator(base_id: str) -> Iterator[str]:
         for n in count(start=1):
             if n == 1:
                 yield base_id

From 3802cb09532ca0de1c981f530db71ce2fed40391 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Mon, 18 Sep 2023 19:18:33 +0300
Subject: [PATCH 16/23] unique_html_id

---
 .../theme/pydata_sphinx_theme/components/navbar-nav.html  | 4 ++--
 .../pydata_sphinx_theme/components/version-switcher.html  | 8 ++++----
 src/pydata_sphinx_theme/toctree.py                        | 6 +++---
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
index 18912067f..e06b26535 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
@@ -1,8 +1,8 @@
 {% set base_id = "pst-more-nav-links" %}
 {% if parent_template_name %}
-  {% set dropdown_id = create_next_id(base_id + "-in-" + parent_template_name) %}
+  {% set dropdown_id = unique_html_id(base_id + "-in-" + parent_template_name) %}
 {% else %}
-  {% set dropdown_id = create_next_id(base_id) %}
+  {% set dropdown_id = unique_html_id(base_id) %}
 {% endif %}
 <nav class="navbar-nav">
   <p class="sidebar-header-items__title"
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
index bde1a4437..973cab58e 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
@@ -2,11 +2,11 @@
 {% set base_button_id = "pst-version-switcher-button" %}
 {% set base_dropdown_id = "pst-version-switcher-list" %}
 {% if parent_template_name %}
-  {% set button_id = create_next_id(base_button_id + "-in-" + parent_template_name) %}
-  {% set dropdown_id = create_next_id(base_dropdown_id + "-in-" + parent_template_name) %}
+  {% set button_id = unique_html_id(base_button_id + "-in-" + parent_template_name) %}
+  {% set dropdown_id = unique_html_id(base_dropdown_id + "-in-" + parent_template_name) %}
 {% else %}
-  {% set button_id = create_next_id(base_button_id) %}
-  {% set dropdown_id = create_next_id(base_dropdown_id) %}
+  {% set button_id = unique_html_id(base_button_id) %}
+  {% set dropdown_id = unique_html_id(base_dropdown_id) %}
 {% endif %}
 <script>
 document.write(`
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index de90dc3ee..1c41ed6ff 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -45,8 +45,8 @@ def get_id_generator(base_id: str) -> Iterator[str]:
             else:
                 yield f"{base_id}-{n}"
 
-    def create_next_id(base_id: str):
-        """Create an id that is build-time unique.
+    def unique_html_id(base_id: str):
+        """Create an id that is unique from other ids created by this function at build time.
 
         The function works by sequentially returning "<base_id>", "<base_id>-2",
         "<base_id>-3", etc. each time it is called.
@@ -347,7 +347,7 @@ def navbar_align_class() -> List[str]:
             )
         return align_options[align]
 
-    context["create_next_id"] = create_next_id
+    context["unique_html_id"] = unique_html_id
     context["generate_header_nav_html"] = generate_header_nav_html
     context["generate_toctree_html"] = generate_toctree_html
     context["generate_toc_html"] = generate_toc_html

From 4774b49c7166197428bbe616aedda5eaecfc7bb1 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Mon, 18 Sep 2023 19:19:54 +0300
Subject: [PATCH 17/23] backwards-compat generate_header_nav_html

---
 .../theme/pydata_sphinx_theme/components/navbar-nav.html      | 4 ++--
 src/pydata_sphinx_theme/toctree.py                            | 4 +++-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
index e06b26535..c3ce62a59 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
@@ -13,8 +13,8 @@
   </p>
   <ul class="bd-navbar-elements navbar-nav">
     {{ generate_header_nav_html(
-        dropdown_id,
         n_links_before_dropdown=theme_header_links_before_dropdown,
-        dropdown_text=theme_header_dropdown_text) }}
+        dropdown_text=theme_header_dropdown_text
+        dropdown_id=dropdown_id) }}
   </ul>
 </nav>
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 1c41ed6ff..2c983e333 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -71,7 +71,9 @@ def create_next_id(base_id: str):
 
     @lru_cache(maxsize=None)
     def generate_header_nav_html(
-        n_links_before_dropdown: int = 5, dropdown_text: str = "More", dropdown_id: str = None
+        n_links_before_dropdown: int = 5,
+        dropdown_text: str = "More",
+        dropdown_id: str = "pst-more-nav-links",
     ) -> str:
         """Generate top-level links that are meant for the header navigation.
 

From 0c2e8c3be186c30835b1b51e042ad640bdeaeac1 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Tue, 19 Sep 2023 16:23:07 +0300
Subject: [PATCH 18/23] feedback review

---
 .../pydata_sphinx_theme/components/navbar-nav.html    |  9 +--------
 .../components/version-switcher.html                  | 11 ++---------
 .../theme/pydata_sphinx_theme/sections/header.html    |  4 ----
 .../pydata_sphinx_theme/sections/sidebar-primary.html |  4 ----
 src/pydata_sphinx_theme/toctree.py                    |  6 +++---
 5 files changed, 6 insertions(+), 28 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
index c3ce62a59..e9e465fcf 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html
@@ -1,9 +1,3 @@
-{% set base_id = "pst-more-nav-links" %}
-{% if parent_template_name %}
-  {% set dropdown_id = unique_html_id(base_id + "-in-" + parent_template_name) %}
-{% else %}
-  {% set dropdown_id = unique_html_id(base_id) %}
-{% endif %}
 <nav class="navbar-nav">
   <p class="sidebar-header-items__title"
      role="heading"
@@ -14,7 +8,6 @@
   <ul class="bd-navbar-elements navbar-nav">
     {{ generate_header_nav_html(
         n_links_before_dropdown=theme_header_links_before_dropdown,
-        dropdown_text=theme_header_dropdown_text
-        dropdown_id=dropdown_id) }}
+        dropdown_text=theme_header_dropdown_text) }}
   </ul>
 </nav>
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
index 973cab58e..874f10d5b 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
@@ -1,13 +1,6 @@
 {# As the version switcher will only work when JavaScript is enabled, we add it through JavaScript. #}
-{% set base_button_id = "pst-version-switcher-button" %}
-{% set base_dropdown_id = "pst-version-switcher-list" %}
-{% if parent_template_name %}
-  {% set button_id = unique_html_id(base_button_id + "-in-" + parent_template_name) %}
-  {% set dropdown_id = unique_html_id(base_dropdown_id + "-in-" + parent_template_name) %}
-{% else %}
-  {% set button_id = unique_html_id(base_button_id) %}
-  {% set dropdown_id = unique_html_id(base_dropdown_id) %}
-{% endif %}
+{%- set button_id = unique_html_id("pst-version-switcher-button") -%}
+{%- set dropdown_id = unique_html_id("pst-version-switcher-list") -%}
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html
index 1376a523c..01744a812 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html
@@ -1,7 +1,3 @@
-{# Set parent_template_name as a way for child templates included by this
-template to access the template name. This can be used, for example, when
-generating HTML IDs #}
-{% set parent_template_name = "header" %}
 {% if theme_navbar_start or theme_navbar_center or theme_navbar_end or theme_navbar_persistent %}
 <div class="bd-header__inner bd-page-width">
   <label class="sidebar-toggle primary-toggle" for="__primary">
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html
index 629d05fc0..af21e502d 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-primary.html
@@ -1,8 +1,4 @@
 {% block docs_sidebar %}
-{# Set parent_template_name as a way for child templates included by this
-  template to access the template name. This can be used, for example, when
-  generating HTML IDs #}
-{% set parent_template_name = "sidebar-primary" %}
 {% if theme_navbar_center or theme_navbar_end or sidebars or theme_primary_sidebar_end %}
   {# Header items that will be displayed in the sidebar on mobile #}
   <div class="sidebar-header-items sidebar-primary__section">
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 2c983e333..da965e6fc 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -38,7 +38,7 @@ def add_toctree_functions(
     """Add functions so Jinja templates can add toctree objects."""
 
     @lru_cache(maxsize=None)
-    def get_id_generator(base_id: str) -> Iterator[str]:
+    def create_or_get_id_generator(base_id: str) -> Iterator[str]:
         for n in count(start=1):
             if n == 1:
                 yield base_id
@@ -51,7 +51,7 @@ def unique_html_id(base_id: str):
         The function works by sequentially returning "<base_id>", "<base_id>-2",
         "<base_id>-3", etc. each time it is called.
         """
-        return next(get_id_generator(base_id))
+        return next(create_or_get_id_generator(base_id))
 
     @lru_cache(maxsize=None)
     def get_id_generator(base_id: str) -> Iterator[str]:
@@ -73,7 +73,6 @@ def create_next_id(base_id: str):
     def generate_header_nav_html(
         n_links_before_dropdown: int = 5,
         dropdown_text: str = "More",
-        dropdown_id: str = "pst-more-nav-links",
     ) -> str:
         """Generate top-level links that are meant for the header navigation.
 
@@ -184,6 +183,7 @@ def generate_header_nav_html(
         ]
 
         if links_dropdown:
+            dropdown_id = unique_html_id("pst-more-nav-links")
             links_dropdown_html = "\n".join(links_dropdown)
             out += f"""
             <li class="nav-item dropdown">

From b348d858299dfe4857844d4932200e23883b8b50 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Tue, 19 Sep 2023 16:56:55 +0300
Subject: [PATCH 19/23] update fixture

---
 tests/test_build/navbar_switcher.html | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/tests/test_build/navbar_switcher.html b/tests/test_build/navbar_switcher.html
index e22075149..dde8afc00 100644
--- a/tests/test_build/navbar_switcher.html
+++ b/tests/test_build/navbar_switcher.html
@@ -1,20 +1,20 @@
 <script>
  document.write(`
   <div class="version-switcher__container dropdown">
-    <button id="pst-version-switcher-button-in-header" 
+    <button id="pst-version-switcher-button-2" 
       type="button" 
       class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
       data-bs-toggle="dropdown" 
       aria-haspopup="listbox"
-      aria-controls="pst-version-switcher-list-in-header" 
+      aria-controls="pst-version-switcher-list-2" 
       aria-label="Version switcher list"
     >
       Choose version  <!-- this text may get changed later by javascript -->
       <span class="caret"></span>
     </button>
-    <div id="pst-version-switcher-list-in-header"
+    <div id="pst-version-switcher-list-2"
       class="version-switcher__menu dropdown-menu list-group-flush py-0"
-      role="listbox" aria-labelledby="pst-version-switcher-button-in-header">
+      role="listbox" aria-labelledby="pst-version-switcher-button-2">
       <!-- dropdown will be populated by javascript on page load -->
     </div>
   </div>

From 1fddd8193b618408f9ff3d439cf1adf35bfcfbd4 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Tue, 19 Sep 2023 17:34:09 +0300
Subject: [PATCH 20/23] ughhhh...caching

---
 src/pydata_sphinx_theme/toctree.py | 53 +++++++++++++++++-------------
 1 file changed, 31 insertions(+), 22 deletions(-)

diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index 7ad4b02f6..b7d048a6e 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -53,28 +53,10 @@ def unique_html_id(base_id: str):
         """
         return next(create_or_get_id_generator(base_id))
 
+    # This function was only created to separate out the cacheable versus
+    # uncacheable part of generate_header_nav_html
     @lru_cache(maxsize=None)
-    def generate_header_nav_html(
-        n_links_before_dropdown: int = 5, dropdown_text: str = "More"
-    ) -> str:
-        """Generate top-level links that are meant for the header navigation.
-
-        We use this function instead of the TocTree-based one used for the
-        sidebar because this one is much faster for generating the links and
-        we don't need the complexity of the full Sphinx TocTree.
-
-        This includes two kinds of links:
-
-        - Links to pages described listed in the root_doc TocTrees
-        - External links defined in theme configuration
-
-        Additionally it will create a dropdown list for several links after
-        a cutoff.
-
-        Parameters:
-            n_links_before_dropdown:The number of links to show before nesting the remaining links in a Dropdown element.
-            dropdown_text:Text of the dropdown element button.
-        """
+    def generate_header_nav_before_dropdown(n_links_before_dropdown):
         try:
             n_links_before_dropdown = int(n_links_before_dropdown)
         except Exception:
@@ -165,8 +147,35 @@ def generate_header_nav_html(
             for html in links_html[n_links_before_dropdown:]
         ]
 
+        return out, links_dropdown
+
+    def generate_header_nav_html(
+        n_links_before_dropdown: int = 5, dropdown_text: str = "More"
+    ) -> str:
+        """Generate top-level links that are meant for the header navigation.
+
+        We use this function instead of the TocTree-based one used for the
+        sidebar because this one is much faster for generating the links and
+        we don't need the complexity of the full Sphinx TocTree.
+
+        This includes two kinds of links:
+
+        - Links to pages described listed in the root_doc TocTrees
+        - External links defined in theme configuration
+
+        Additionally it will create a dropdown list for several links after
+        a cutoff.
+
+        Parameters:
+            n_links_before_dropdown:The number of links to show before nesting the remaining links in a Dropdown element.
+            dropdown_text:Text of the dropdown element button.
+        """
+        out, links_dropdown = generate_header_nav_before_dropdown(
+            n_links_before_dropdown
+        )
+
         if links_dropdown:
-            dropdown_id = unique_html_id("pst-more-nav-links")
+            dropdown_id = unique_html_id("pst-nav-more-links")
             links_dropdown_html = "\n".join(links_dropdown)
             out += f"""
             <li class="nav-item dropdown">

From 5c73174cc9ddc88199946e57fd77d821f9d4fbdc Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Tue, 26 Sep 2023 11:16:13 +0300
Subject: [PATCH 21/23] code cleanup

---
 .../components/version-switcher.html                   | 10 +++++-----
 src/pydata_sphinx_theme/toctree.py                     |  4 ++--
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
index 17e659075..7f5ee9327 100644
--- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
+++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/version-switcher.html
@@ -1,15 +1,15 @@
-{# As the version switcher will only work when JavaScript is enabled, we add it through JavaScript. #}
 {%- set button_id = unique_html_id("pst-version-switcher-button") -%}
 {%- set dropdown_id = unique_html_id("pst-version-switcher-list") -%}
+{# As the version switcher will only work when JavaScript is enabled, we add it through JavaScript. #}
 <script>
 document.write(`
   <div class="version-switcher__container dropdown">
-    <button id="{{ button_id }}" 
-      type="button" 
+    <button id="{{ button_id }}"
+      type="button"
       class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
-      data-bs-toggle="dropdown" 
+      data-bs-toggle="dropdown"
       aria-haspopup="listbox"
-      aria-controls="{{ dropdown_id }}" 
+      aria-controls="{{ dropdown_id }}"
       aria-label="Version switcher list"
     >
       Choose version  <!-- this text may get changed later by javascript -->
diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index b7d048a6e..dd0b04707 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -38,7 +38,7 @@ def add_toctree_functions(
     """Add functions so Jinja templates can add toctree objects."""
 
     @lru_cache(maxsize=None)
-    def create_or_get_id_generator(base_id: str) -> Iterator[str]:
+    def get_or_create_id_generator(base_id: str) -> Iterator[str]:
         for n in count(start=1):
             if n == 1:
                 yield base_id
@@ -51,7 +51,7 @@ def unique_html_id(base_id: str):
         The function works by sequentially returning "<base_id>", "<base_id>-2",
         "<base_id>-3", etc. each time it is called.
         """
-        return next(create_or_get_id_generator(base_id))
+        return next(get_or_create_id_generator(base_id))
 
     # This function was only created to separate out the cacheable versus
     # uncacheable part of generate_header_nav_html

From f3b223e1070485062f899b75e601d8c62c016e33 Mon Sep 17 00:00:00 2001
From: Gabriel Fouasnon <gabriel@fouasnon.com>
Date: Wed, 27 Sep 2023 13:10:03 +0300
Subject: [PATCH 22/23] fix test snapshot

---
 tests/test_build/navbar_switcher.html | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/tests/test_build/navbar_switcher.html b/tests/test_build/navbar_switcher.html
index dde8afc00..c2e27f78b 100644
--- a/tests/test_build/navbar_switcher.html
+++ b/tests/test_build/navbar_switcher.html
@@ -1,12 +1,12 @@
 <script>
  document.write(`
   <div class="version-switcher__container dropdown">
-    <button id="pst-version-switcher-button-2" 
-      type="button" 
+    <button id="pst-version-switcher-button-2"
+      type="button"
       class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle"
-      data-bs-toggle="dropdown" 
+      data-bs-toggle="dropdown"
       aria-haspopup="listbox"
-      aria-controls="pst-version-switcher-list-2" 
+      aria-controls="pst-version-switcher-list-2"
       aria-label="Version switcher list"
     >
       Choose version  <!-- this text may get changed later by javascript -->

From 64a5f4ebb60a0dab51c714064c3a0d4011f3cf54 Mon Sep 17 00:00:00 2001
From: Daniel McCloy <dan@mccloy.info>
Date: Tue, 17 Oct 2023 16:00:08 -0500
Subject: [PATCH 23/23] put comment inside def

---
 src/pydata_sphinx_theme/toctree.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py
index dd0b04707..94a0d9b48 100644
--- a/src/pydata_sphinx_theme/toctree.py
+++ b/src/pydata_sphinx_theme/toctree.py
@@ -53,10 +53,9 @@ def unique_html_id(base_id: str):
         """
         return next(get_or_create_id_generator(base_id))
 
-    # This function was only created to separate out the cacheable versus
-    # uncacheable part of generate_header_nav_html
     @lru_cache(maxsize=None)
     def generate_header_nav_before_dropdown(n_links_before_dropdown):
+        """The cacheable part."""
         try:
             n_links_before_dropdown = int(n_links_before_dropdown)
         except Exception: