Handle RTD enabling addons (#3103)

* Handle RTD enabling addons

* Remove unnecessary theme call

* Update docs/source/conf.py

Co-authored-by: John Litborn <11260241+jakkdl@users.noreply.github.com>

---------

Co-authored-by: John Litborn <11260241+jakkdl@users.noreply.github.com>

Author: A5rocks

docs-requirements.in

@@ -3,7 +3,7 @@
 sphinx >= 6.0
 jinja2
 # >= is necessary to prevent `uv` from selecting a `Sphinx` version this does not support
-sphinx_rtd_theme >= 2
+sphinx_rtd_theme >= 3
 sphinxcontrib-jquery
 sphinxcontrib-trio
 towncrier

docs-requirements.txt

@@ -79,7 +79,7 @@ sphinx-codeautolink==0.15.2
     # via -r docs-requirements.in
 sphinx-hoverxref==1.4.1
     # via -r docs-requirements.in
-sphinx-rtd-theme==2.0.0
+sphinx-rtd-theme==3.0.0
     # via -r docs-requirements.in
 sphinxcontrib-applehelp==2.0.0
     # via sphinx

docs/source/conf.py

@@ -201,6 +201,13 @@ def setup(app: Sphinx) -> None:
     app.connect("source-read", on_read_source)
 
 
+# Our docs use the READTHEDOCS variable, so copied from:
+# https://about.readthedocs.com/blog/2024/07/addons-by-default/
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -374,10 +381,7 @@ def add_mapping(
 # We have to set this ourselves, not only because it's useful for local
 # testing, but also because if we don't then RTD will throw away our
 # html_theme_options.
-import sphinx_rtd_theme
-
 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