[8.10] Fix Read the Docs theme (#2317)

Author: pquentin

.readthedocs.yml

@@ -1,9 +1,11 @@
 version: 2
-sphinx:
-  configuration: docs/sphinx/conf.py
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
 
 python:
-  version: 3.7
   install:
     - requirements: dev-requirements.txt
     - path: .

dev-requirements.txt

@@ -5,7 +5,6 @@ pytest
 pytest-cov
 pytest-asyncio
 coverage
-sphinx
 jinja2
 python-dateutil
 unasync
@@ -22,3 +21,9 @@ pandas; python_version<"3.10"
 
 # Testing the 'search_mvt' API response
 mapbox-vector-tile; python_version<"3.10"
+
+# Docs
+# Override Read the Docs default (sphinx<2 and sphinx-rtd-theme<0.5)
+sphinx>2
+sphinx-rtd-theme>0.5
+sphinx-autodoc-typehints

docs/sphinx/conf.py

@@ -17,14 +17,15 @@
 #  under the License.
 
 import datetime
-import os
 
 import elasticsearch
 
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx"]
 
 autoclass_content = "both"
 
+autodoc_typehints = "description"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -43,13 +44,7 @@
 
 pygments_style = "sphinx"
 
-on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-
-    html_theme = "sphinx_rtd_theme"
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme = "sphinx_rtd_theme"
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

noxfile.py

@@ -109,9 +109,7 @@ def lint(session):
 
 @nox.session()
 def docs(session):
-    session.install(
-        "-rdev-requirements.txt", "sphinx-rtd-theme", "sphinx-autodoc-typehints"
-    )
+    session.install("-rdev-requirements.txt")
     session.install(".")
     session.run("python", "-m", "pip", "install", "sphinx-autodoc-typehints")