From 303c4c3dd7827e846935911e214fea38aa9435f2 Mon Sep 17 00:00:00 2001
From: Yannick DAYER <yannick.dayer@idiap.ch>
Date: Fri, 7 Jun 2024 11:15:20 +0200
Subject: [PATCH] doc: add auto-intersphinx to conf.py and in deps.
---
doc/conf.py | 9 +++++++++
pyproject.toml | 1 +
2 files changed, 10 insertions(+)
diff --git a/doc/conf.py b/doc/conf.py
index 095b755..a6321be 100755
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -27,6 +27,7 @@ extensions = [
"sphinx.ext.viewcode",
"sphinx.ext.mathjax",
"matplotlib.sphinxext.plot_directive",
+ "auto_intersphinx",
]
# Be picky about warnings
@@ -231,3 +232,11 @@ autodoc_default_options = {
"undoc-members": True,
"show-inheritance": True,
}
+
+auto_intersphinx_packages = [
+ ("python", "3"),
+ "numpy",
+ "scikit-learn",
+ "dask",
+]
+auto_intersphinx_catalog = "catalog.json"
diff --git a/pyproject.toml b/pyproject.toml
index cc86975..e6efeeb 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -42,6 +42,7 @@
[project.optional-dependencies]
qa = ["pre-commit"]
doc = [
+ "auto-intersphinx",
"sphinx",
"sphinx_rtd_theme",
"sphinx-autodoc-typehints",
--
GitLab