docs: Change to furo (#114)

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+formats:
+  - epub
+  - pdf
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/conf.py

@@ -90,7 +90,15 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "default"
+try:
+    import furo
+
+    html_theme = "furo"
+    html_theme_options = {
+        "navigation_with_keys": True,
+    }
+except ImportError:
+    html_theme = "default"
 
 # 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

docs/requirements.in

@@ -0,0 +1,7 @@
+furo
+MarkupSafe
+sphinx
+sphinx-autobuild
+sphinxext-opengraph
+sphinxcontrib-spelling
+sphinx-autobuild

docs/requirements.txt

@@ -0,0 +1,87 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile
+#
+alabaster==0.7.13
+    # via sphinx
+babel==2.13.1
+    # via sphinx
+beautifulsoup4==4.12.2
+    # via furo
+certifi==2023.11.17
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+colorama==0.4.6
+    # via sphinx-autobuild
+docutils==0.20.1
+    # via sphinx
+furo==2023.9.10
+    # via -r requirements.in
+idna==3.6
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.2
+    # via sphinx
+livereload==2.6.3
+    # via sphinx-autobuild
+markupsafe==2.1.3
+    # via
+    #   -r requirements.in
+    #   jinja2
+packaging==23.2
+    # via sphinx
+pyenchant==3.2.2
+    # via sphinxcontrib-spelling
+pygments==2.17.2
+    # via
+    #   furo
+    #   sphinx
+requests==2.31.0
+    # via sphinx
+six==1.16.0
+    # via livereload
+snowballstemmer==2.2.0
+    # via sphinx
+soupsieve==2.5
+    # via beautifulsoup4
+sphinx==7.2.6
+    # via
+    #   -r requirements.in
+    #   furo
+    #   sphinx-autobuild
+    #   sphinx-basic-ng
+    #   sphinxcontrib-applehelp
+    #   sphinxcontrib-devhelp
+    #   sphinxcontrib-htmlhelp
+    #   sphinxcontrib-qthelp
+    #   sphinxcontrib-serializinghtml
+    #   sphinxcontrib-spelling
+    #   sphinxext-opengraph
+sphinx-autobuild==2021.3.14
+    # via -r requirements.in
+sphinx-basic-ng==1.0.0b2
+    # via furo
+sphinxcontrib-applehelp==1.0.7
+    # via sphinx
+sphinxcontrib-devhelp==1.0.5
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.4
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.6
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.9
+    # via sphinx
+sphinxcontrib-spelling==8.0.0
+    # via -r requirements.in
+sphinxext-opengraph==0.9.0
+    # via -r requirements.in
+tornado==6.4
+    # via livereload
+urllib3==2.1.0
+    # via requests