Issue #12290 - Docs using Furo Theme W/ Dark Mode (#12326)

* furo theme for docs site * removing duplicate tocs from deprecations and reference pages * removing pallets references in code and config * reverting trainings to sidebar * removed sphinx style and unpinned packaging version * updated styles
pytest-dev · May 21, 2024 · cbf6bd9 · cbf6bd9
1 parent 5d5c9dc
commit cbf6bd9
Show file tree

Hide file tree

Showing 12 changed files with 37 additions and 55 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -358,6 +358,7 @@ Sadra Barikbin
 Saiprasad Kale
 Samuel Colvin
 Samuel Dion-Girardeau
+Samuel Jirovec
 Samuel Searles-Bryant
 Samuel Therrien (Avasam)
 Samuele Pedroni

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -5,10 +5,6 @@ Contribution getting started
 Contributions are highly welcomed and appreciated.  Every little bit of help counts,
 so do not hesitate!
 
-.. contents::
-   :depth: 2
-   :backlinks: none
-
 
 .. _submitfeedback:
 

diff --git a/changelog/12290.doc.rst b/changelog/12290.doc.rst
@@ -0,0 +1 @@
+Updated Sphinx theme to use Furo instead of Flask, enabling Dark mode theme.
diff --git a/doc/en/img/pytest1.png → doc/en/_static/pytest1.png b/doc/en/img/pytest1.png → doc/en/_static/pytest1.png
diff --git a/doc/en/_templates/sidebar/brand.html b/doc/en/_templates/sidebar/brand.html
@@ -0,0 +1,7 @@
+<style>
+    .logo {text-align: center;}
+</style>
+
+<a class="logo" href="{{ pathto('contents') }}">
+    <img src="{{ pathto('_static/pytest1.png', 1) }}" width="70%" height="70%" text="Pytest Logo"/>
+</a>
diff --git a/doc/en/_templates/slim_searchbox.html b/doc/en/_templates/slim_searchbox.html
diff --git a/doc/en/_templates/style.html b/doc/en/_templates/style.html
@@ -0,0 +1,7 @@
+<style>
+    ul {list-style: none;}
+    li {margin: 0.4em 0;}
+    @media (min-width: 46em) {
+        #features {width: 50%;}
+    }
+</style>
diff --git a/doc/en/conf.py b/doc/en/conf.py
@@ -15,9 +15,7 @@
 #
 # The full version, including alpha/beta/rc tags.
 # The short X.Y version.
-import os
 import shutil
-import sys
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
@@ -65,7 +63,6 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    "pallets_sphinx_themes",
     "pygments_pytest",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
@@ -140,10 +137,6 @@
 # output. They are ignored by default.
 # show_authors = False
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
-
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 
@@ -216,12 +209,9 @@
 
 # -- Options for HTML output ---------------------------------------------------
 
-sys.path.append(os.path.abspath("_themes"))
-html_theme_path = ["_themes"]
-
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "flask"
+html_theme = "furo"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -266,18 +256,24 @@
 
 html_sidebars = {
     "index": [
-        "slim_searchbox.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
         "sidebarintro.html",
         "globaltoc.html",
         "links.html",
-        "sourcelink.html",
+        "sidebar/scroll-end.html",
+        "style.html",
     ],
     "**": [
-        "slim_searchbox.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/scroll-start.html",
         "globaltoc.html",
         "relations.html",
         "links.html",
-        "sourcelink.html",
+        "sidebar/scroll-end.html",
+        "style.html",
     ],
 }
 
@@ -337,10 +333,6 @@
     )
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-latex_logo = "img/pytest1.png"
-
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 # latex_use_parts = False

diff --git a/doc/en/deprecations.rst b/doc/en/deprecations.rst
@@ -7,10 +7,6 @@ This page lists all pytest features that are currently deprecated or have been r
 The objective is to give users a clear rationale why a certain feature has been removed, and what alternatives
 should be used instead.
 
-.. contents::
-    :depth: 3
-    :local:
-
 
 Deprecated Features
 -------------------

diff --git a/doc/en/index.rst b/doc/en/index.rst
@@ -1,16 +1,16 @@
 :orphan:
 
-.. sidebar:: Next Open Trainings and Events
+.. _features:
 
-   - `Professional Testing with Python <https://python-academy.com/courses/python_course_testing.html>`_, via `Python Academy <https://www.python-academy.com/>`_ (3 day in-depth training):
-      * **June 11th to 13th 2024**, Remote
-      * **March 4th to 6th 2025**, Leipzig, Germany / Remote
-   - `pytest development sprint <https://github.com/pytest-dev/sprint>`_, **June 17th -- 22nd 2024**
-   - pytest tips and tricks for a better testsuite, `Europython 2024 <https://ep2024.europython.eu/>`_, **July 8th -- 14th 2024** (3h), Prague
+.. sidebar:: **Next Open Trainings and Events**
 
-   Also see :doc:`previous talks and blogposts <talks>`.
+    - `Professional Testing with Python <https://python-academy.com/courses/python_course_testing.html>`_, via `Python Academy <https://www.python-academy.com/>`_ (3 day in-depth training):
+        * **June 11th to 13th 2024**, Remote
+        * **March 4th to 6th 2025**, Leipzig, Germany / Remote
+    - `pytest development sprint <https://github.com/pytest-dev/sprint>`_, **June 17th -- 22nd 2024**
+    - pytest tips and tricks for a better testsuite, `Europython 2024 <https://ep2024.europython.eu/>`_, **July 8th -- 14th 2024** (3h), Prague
 
-.. _features:
+    Also see :doc:`previous talks and blogposts <talks>`
 
 pytest: helps you write better programs
 =======================================
@@ -25,7 +25,6 @@ scale to support complex functional testing for applications and libraries.
 
 **PyPI package name**: :pypi:`pytest`
 
-
 A quick example
 ---------------
 

diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst
@@ -7,9 +7,6 @@ API Reference
 
 This page contains the full reference to pytest's API.
 
-.. contents::
-    :depth: 3
-    :local:
 
 Constants
 ---------

diff --git a/doc/en/requirements.txt b/doc/en/requirements.txt
@@ -1,4 +1,3 @@
-pallets-sphinx-themes
 pluggy>=1.5.0
 pygments-pytest>=2.3.0
 sphinx-removed-in>=0.2.0
@@ -8,4 +7,5 @@ sphinxcontrib-svg2pdfconverter
 # Pin packaging because it no longer handles 'latest' version, which
 # is the version that is assigned to the docs.
 # See https://github.com/pytest-dev/pytest/pull/10578#issuecomment-1348249045.
-packaging <22
+packaging
+furo