Merge pull request #6158 from hugovk/furo

Replace Read the Docs Sphinx Theme with Furo

Author: radarhere

.github/workflows/test.yml

@@ -93,7 +93,7 @@ jobs:
     - name: Docs
       if: startsWith(matrix.os, 'ubuntu') && matrix.python-version == 3.10
       run: |
-        python3 -m pip install sphinx-copybutton sphinx-issues sphinx-removed-in sphinx-rtd-theme sphinxext-opengraph
+        python3 -m pip install furo sphinx-copybutton sphinx-issues sphinx-removed-in sphinxext-opengraph
         make doccheck
 
     - name: After success

docs/conf.py

@@ -16,8 +16,6 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
 
-import sphinx_rtd_theme
-
 import PIL
 
 # -- General configuration ------------------------------------------------
@@ -126,13 +124,15 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+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
 # documentation.
-# html_theme_options = {}
+html_theme_options = {
+    "light_logo": "pillow-logo-dark-text.png",
+    "dark_logo": "pillow-logo.png",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -146,7 +146,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "resources/pillow-logo.png"
+# html_logo = "resources/pillow-logo.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -311,10 +311,7 @@
 
 
 def setup(app):
-    app.add_js_file("js/script.js")
-    app.add_css_file("css/styles.css")
     app.add_css_file("css/dark.css")
-    app.add_css_file("css/light.css")
 
 
 # GitHub repo for sphinx-issues

docs/handbook/image-file-formats.rst

@@ -24,8 +24,6 @@ attribute will be ``None``.
 Fully supported formats
 -----------------------
 
-.. contents::
-
 BLP
 ^^^