Switch to Furo

- Add Furo dependency to docs/requirements.txt - Drop a fair bit of theme configuration - Fix the toctree declarations in index.rst - Move stuff around as Furo isn't 100% compatible with Alabaster Furo was chosen as it provides excellent mobile support, user controllable light/dark theming, and is overall easier to read
psf · Jan 21, 2022 · d7b6a30 · d7b6a30
1 parent 95c03b9
commit d7b6a30
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 70 deletions.
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
diff --git a/docs/conf.py b/docs/conf.py
@@ -115,29 +115,8 @@ def make_pypi_svg(version: str) -> None:
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
-
-html_sidebars = {
-    "**": [
-        "about.html",
-        "navigation.html",
-        "relations.html",
-        "searchbox.html",
-    ]
-}
-
-html_theme_options = {
-    "show_related": False,
-    "description": "“Any color you like.”",
-    "github_button": True,
-    "github_user": "psf",
-    "github_repo": "black",
-    "github_type": "star",
-    "show_powered_by": True,
-    "fixed_sidebar": True,
-    "logo": "logo2.png",
-}
-
+html_theme = "furo"
+html_logo = "_static/logo2-readme.png"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/index.rst b/docs/index.rst
@@ -99,6 +99,7 @@ Contents
 .. toctree::
    :maxdepth: 3
    :includehidden:
+   :caption: User Guide
 
    getting_started
    usage_and_configuration/index
@@ -109,17 +110,19 @@ Contents
 .. toctree::
    :maxdepth: 3
    :includehidden:
+   :caption: Development
 
    contributing/index
    change_log
    authors
 
 .. toctree::
    :hidden:
+   :caption: Project Links
 
-   GitHub ↪ <https://github.com/psf/black>
-   PyPI ↪ <https://pypi.org/project/black>
-   Chat ↪ <https://discord.gg/RtVdv86PrH>
+   GitHub <https://github.com/psf/black>
+   PyPI <https://pypi.org/project/black>
+   Chat <https://discord.gg/RtVdv86PrH>
 
 Indices and tables
 ==================

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,3 +4,4 @@ myst-parser==0.16.1
 Sphinx==4.4.0
 sphinxcontrib-programoutput==0.17
 sphinx_copybutton==0.4.0
+furo==2022.1.2