Squashed commit of the following:

commit 317bb3385d
Author: Martin Wendt <mar10@wwwendt.de>
Date:   Wed Aug 9 20:29:26 2023 +0200

    Cleanup

commit f3cf3ea0a2
Merge: fc82ef8 5a6f1f0
Author: Martin Wendt <mar10@wwwendt.de>
Date:   Wed Aug 9 20:03:07 2023 +0200

    Merge branch 'master' into furo_docs

commit fc82ef8da6
Author: Martin Wendt <mar10@wwwendt.de>
Date:   Wed Aug 9 19:54:23 2023 +0200

    WiP

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 - BREAKING:
   - See option `fs_dav_provider.follow_symlinks` below.
-- Stop testing Python 3.7 (EOL: 2023-06-27)
+  - Stop testing Python 3.7 (EOL: 2023-06-27)
 - Install pam_dc dependencies using extra syntax: `pip install wsgidav[pam]`
 - #281 Requesting range off end of file does not return 416 status code
 - #282 Hotfix PUT request without content-length (fix for Finder on MacOS Ventura)
@@ -22,6 +22,7 @@
 - Add `fs_dav_provider.shadow_map`, which can be used to blend in a favicon
   when context is opened inline (#230)
 - Remove (unused) interface definitions
+- Use the [Furo](https://github.com/pradyunsg/furo) documentation theme
 
 ## 4.2.0 / 2023-02-18
 

Pipfile

@@ -23,8 +23,8 @@ recommonmark = "*"
 requests = "*"
 rope = "*"
 setuptools = "*"
-Sphinx = "*"
-sphinx_rtd_theme = "*"
+# Sphinx = "*"
+# sphinx_rtd_theme = "*"
 stressor = "*"
 tox = "*"  # "~=3.13"
 twine = "*"

docs/source/conf.py

@@ -121,25 +121,49 @@ autodoc_mock_imports = [
 # a list of builtin themes.
 #
 # html_theme = "alabaster"
+html_theme = "furo"
 
-if not on_rtd:
-    # only import and set the theme if we're building docs locally
-    # otherwise, readthedocs.org uses their theme by default, so no need to specify it
-    import sphinx_rtd_theme
+# if not on_rtd:
+#     # only import and set the theme if we're building docs locally
+#     # otherwise, readthedocs.org uses their theme by default, so no need to specify it
+#     import sphinx_rtd_theme
 
-    html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#     html_theme = "sphinx_rtd_theme"
+#     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # 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 = {
+    # See https://pradyunsg.me/furo/customisation/
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
 # html_theme = 'bootstrap'
 # html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
+# MyST Markdown Support
+myst_enable_extensions = [
+    "dollarmath",
+    "amsmath",
+    "deflist",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
+    "colon_fence",
+    "smartquotes",
+    "replacements",
+    "linkify",
+    "strikethrough",
+    "substitution",
+    "tasklist",
+]
+myst_number_code_blocks = ["typescript"]
+myst_heading_anchors = 2
+myst_footnote_transition = True
+myst_dmath_double_inline = True
+
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 #html_title = None

docs/source/requirements.txt

@@ -7,7 +7,8 @@ PyYAML~=6.0
 # RTD:
 sphinx~=7.1
 sphinx_rtd_theme~=1.2
-readthedocs-sphinx-search==0.3.1
+furo
+#readthedocs-sphinx-search==0.3.1
 recommonmark~=0.7.1
 # MyST
 myst-parser[linkify]

requirements-dev.txt

@@ -13,8 +13,8 @@ pytest-cov~=1.8
 recommonmark
 requests
 setuptools~=40.2
-Sphinx
-sphinx_rtd_theme
+#Sphinx
+#sphinx_rtd_theme
 stressor
 tox~=3.13
 twine~=1.11

tox.ini

@@ -147,7 +147,8 @@ changedir = docs
 deps =
     sphinx
     recommonmark
-    sphinx_rtd_theme
+    #sphinx_rtd_theme
+    furo
     readthedocs-sphinx-search
 commands =
     # http://www.sphinx-doc.org/en/master/man/sphinx-build.html