switch the HTML sphinx theme to furo (#149)

* install furo instead of sphinx-rtd-theme

* use the new theme

* fix the template

* changelog [skip-ci]

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,8 @@
- - [ ] Closes #xxxx
- - [ ] Tests added
- - [ ] Passes `pre-commit run --all-files`
- - [ ] User visible changes (including notable bug fixes) are documented in `changelog.rst`
- - [ ] New features are documented in the docs
+- [ ] Closes #xxxx
+- [ ] Tests added
+- [ ] Passes `pre-commit run --all-files`
+- [ ] User visible changes (including notable bug fixes) are documented in `changelog.rst`
+- [ ] New features are documented in the docs
 
 <!--
 By default, the upstream-dev CI is only run when triggered by the github website (`workflow_dispatch`)

ci/requirements/doc.txt

@@ -1,4 +1,4 @@
 sphinx>=5
-sphinx_rtd_theme>=1.0
+furo
 ipython
 more-itertools

doc/changelog.rst

@@ -3,6 +3,7 @@ Changelog
 v0.4.0 (*unreleased*)
 ---------------------
 - replace docstrings by modifying by token (:pull:`144`)
+- switch the html theme to `furo <https://pradyunsg.me/furo>`_ (:pull:`149`)
 
 v0.3.6 (25 August 2022)
 -----------------------

doc/conf.py

@@ -51,7 +51,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
 # 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,