update pip dependency

tkknight · Nov 7, 2023 · 74fadb1 · 74fadb1
1 parent c8f363d
commit 74fadb1
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -29,3 +29,5 @@ python:
   install:
     - method: pip
       path: .
+      extra_requirements:
+        - docs
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -164,6 +164,7 @@ def _dotv(version):
 ]
 
 if on_rtd:
+    # search as you type on readthedocs only.
     extensions.extend(["sphinx_search.extension"])
 
 if skip_api == "1":

diff --git a/pyproject.toml b/pyproject.toml
@@ -70,6 +70,9 @@ readme = {file = "README.md", content-type = "text/markdown"}
 include = ["iris*"]
 where = ["lib"]
 
+[tool.setuptools.dynamic.optional-dependencies]
+docs = {file = ["requirements/pypi-optional-docs.txt"]}
+
 [tool.setuptools_scm]
 write_to = "lib/iris/_version.py"
 local_scheme = "dirty-tag"

diff --git a/requirements/pypi-optional-docs.txt b/requirements/pypi-optional-docs.txt
@@ -0,0 +1 @@
+readthedocs-sphinx-search