WiP

Pipfile

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

docs/source/conf.py

@@ -102,6 +102,7 @@ exclude_patterns = []
 
 autodoc_mock_imports = [
     "bson",
+    "cheroot",
     "couchdb",
     "jinja2",
     "mercurial",
@@ -120,25 +121,63 @@ 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 = {
+#     # "logo": "favicon-32x32.png",
+#     # "logo_text_align": "left",
+#     "show_powered_by": False,
+#     "github_user": "mar10",
+#     "github_repo": "WsgiDAV",
+#     "github_banner": True,
+#     "github_button": True,
+#     "github_type": "star",
+#     # "github_size": "small",
+#     "github_count": "true",
+#     # "travis_button": True,
+#     # "codecov_button": True,
+#     "show_related": False,
+#     "note_bg": "#FFF59C",
+# }
 
 # 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

@@ -15,6 +15,7 @@ requests
 setuptools~=40.2
 Sphinx~=7.1
 sphinx_rtd_theme~=1.2
+furo
 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