Upgrade docs to Sphinx 6.x & Furo theme 2024.04.27

justinmayer · May 14, 2024 · d919efb · d919efb
1 parent 74f0529
commit d919efb
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/docs/_templates/page.html b/docs/_templates/page.html
@@ -13,6 +13,12 @@
   <div class="visually-hidden">Hide table of contents sidebar</div>
 </label>
 
+<a class="skip-to-content muted-link" href="#furo-main-content">
+  {%- trans -%}
+  Skip to content
+  {%- endtrans -%}
+</a>
+
 {% if theme_announcement -%}
 <div class="announcement">
   <aside class="announcement-content">
@@ -68,19 +74,11 @@
           <span>{% trans %}Back to top{% endtrans %}</span>
         </a>
         <div class="content-icon-container">
-          {#- Edit this page, on GitHub -#}
-          {%- if READTHEDOCS and conf_py_path and page_source_suffix and github_user != "None" and github_repo != "None" and github_version %}
-          <div class="edit-this-page">
-            <a class="muted-link" href="https://github.com/{{ github_user }}/{{ github_repo }}/edit/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" title="{{ _("Edit this page") }}">
-              <svg aria-hidden="true" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
-                <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
-                <path d="M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" />
-                <line x1="13.5" y1="6.5" x2="17.5" y2="10.5" />
-              </svg>
-              <span class="visually-hidden">{{ _("Edit this page") }}</span>
-            </a>
-          </div>
-          {% endif %}
+          {% if theme_top_of_page_button == "edit" -%}
+          {%- include "components/edit-this-page.html" with context -%}
+          {%- elif theme_top_of_page_button != None -%}
+          {{ warning("Got an unsupported value for 'top_of_page_button'") }}
+          {%- endif -%}
           {#- Theme toggle -#}
           <div class="theme-toggle-container theme-toggle-content">
             <button class="theme-toggle">
@@ -95,7 +93,7 @@
             <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
           </label>
         </div>
-        <article role="main">
+        <article role="main" id="furo-main-content">
           {% block content %}{{ body }}{% endblock %}
         </article>
       </div>
@@ -110,12 +108,12 @@
                 </div>
                 <div class="title">{{ next.title }}</div>
               </div>
-              <svg><use href="#svg-arrow-right"></use></svg>
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
           {%- endif %}
           {% if prev -%}
             <a class="prev-page" href="{{ prev.link }}">
-              <svg><use href="#svg-arrow-right"></use></svg>
+              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>{{ _("Previous") }}</span>
@@ -153,6 +151,7 @@
             {%- endif %}
           </div>
           <div class="right-details">
+            {% if theme_footer_icons or READTHEDOCS -%}
             <div class="icons">
               {% if theme_footer_icons -%}
               {% for icon_dict in theme_footer_icons -%}
@@ -179,6 +178,7 @@
               {%- endif -%}
               {%- endif %}
             </div>
+            {%- endif %}
           </div>
         </div>
         {% endblock footer %}
@@ -190,7 +190,7 @@
       <div class="toc-sticky toc-scroll">
         <div class="toc-title-container">
           <span class="toc-title">
-            {{ _("Contents") }}
+            {{ _("On this page") }}
           </span>
         </div>
         <div class="toc-tree-container">

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-furo==2022.04.07
-sphinx==4.5.0
+furo==2024.04.27
+sphinx==6.2.1
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,7 @@ webauthn = "^1.6.0"
 black = "^23.3"
 flake8 = "^5.0"
 Flake8-pyproject = "^1.2.3"
-furo = "2022.04.07"
+furo = "2024.04.27"
 invoke = "^2.0"
 isort = "^5.11"
 livereload = "^2.6"
@@ -53,7 +53,7 @@ pytest-cov = "^3.0"
 pytest-django = "^4.0"
 pytest-sugar = "^0.9"
 pytest-xdist = "^2.1"
-sphinx = "^4.0"
+sphinx = "^6.0"
 Werkzeug = "^2.0"
 
 [tool.autopub]