docs: configure sphinx-tippy (#874)

bjlittle · Jun 28, 2024 · 6efde54 · 6efde54
1 parent f94b842
commit 6efde54
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -177,6 +177,25 @@ def autolog(message: str, section: str | None = None, color: str | None = None)
 autolog(f"{package_dir=}", section="General")
 
 
+# sphinx-tippy options -------------------------------------------------------
+# See https://github.com/sphinx-extensions2/sphinx-tippy
+
+# optional dependency (unavailable on conda-forge)
+with contextlib.suppress(ModuleNotFoundError):
+    import sphinx_tippy  # noqa: F401
+
+    extensions.append("sphinx_tippy")
+
+tippy_enable_wikitips = False
+tippy_enable_doitips = False
+tippy_rtd_urls = [
+    "https://www.sphinx-doc.org/en/master/",
+]
+tippy_skip_anchor_classes = ("headerlink", "sd-stretched-link")
+tippy_anchor_parent_selector = "article.bd-article"
+tippy_props = {"maxWidth": 700, "placement": "top-start", "theme": "light"}
+
+
 # sphinx-tags options --------------------------------------------------------
 # See https://sphinx-tags.readthedocs.io/en/latest/index.html
 

diff --git a/requirements/geovista.yml b/requirements/geovista.yml
@@ -58,7 +58,6 @@ dependencies:
   - sphinx-design
   - sphinx-gallery >=0.16
   - sphinx-tags
-  - sphinx-tippy
   - sphinx-togglebutton
   - ipywidgets
   - jupyter-server-proxy