Revert "docs: Switch to Furo"

This reverts commit 859233b. The furo theme requires far more changes than this, and the RTD theme now supports Sphinx 5.x. Signed-off-by: Stephen Finucane <[email protected]>
getpatchwork · Jan 17, 2024 · e83d747 · e83d747
1 parent ead2164
commit e83d747
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 17 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,11 +1,11 @@
 # pwclient documentation build configuration file
 
 try:
-    import furo  # noqa
+    import sphinx_rtd_theme  # noqa
 
-    has_furo_theme = True
+    has_rtd_theme = True
 except ImportError:
-    has_furo_theme = False
+    has_rtd_theme = False
 
 # -- General configuration ------------------------------------------------
 
@@ -18,7 +18,7 @@
 ]
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'contents'
 
 # General information about the project.
 project = 'pwclient'
@@ -33,5 +33,5 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-if has_furo_theme:
-    html_theme = 'furo'
+if has_rtd_theme:
+    html_theme = 'sphinx_rtd_theme'
diff --git a/docs/contents.rst b/docs/contents.rst
@@ -0,0 +1,9 @@
+Contents
+========
+
+.. toctree::
+
+   index
+   configuration
+   usage
+   release-notes
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,13 +4,3 @@ pwclient
 .. include:: ../README.rst
    :start-line: 18
    :end-line: -7
-
-Documentation
--------------
-
-.. toctree::
-   :maxdepth: 2
-
-   usage
-   configuration
-   release-notes
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
 sphinx
 reno
-furo
+sphinx_rtd_theme
 sphinxcontrib.autoprogram