From 6ba2aca39fcfb378c13195bc3c738730ca695c31 Mon Sep 17 00:00:00 2001 From: Brian Harring Date: Thu, 25 Jan 2024 12:49:27 -0800 Subject: [PATCH] docs: Add intersphinx linkage to dependencies For any references that go back into those, they're not reachable for doc rendering without this. Use seed_intersphinx_mapping to derive those urls from pyproject.toml sources. Signed-off-by: Brian Harring --- doc/conf.py | 7 +++++++ pyproject.toml | 1 + 2 files changed, 8 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 84aae9ea7..392fcd333 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -33,6 +33,7 @@ "sphinx.ext.ifconfig", "sphinx.ext.viewcode", "snakeoil.dist.sphinxext", + "seed_intersphinx_mapping", ] # Add any paths that contain templates here, relative to this directory. @@ -324,3 +325,9 @@ # If false, no index is generated. # epub_use_index = True + +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), +} + +pkg_requirements_source = 'pyproject' diff --git a/pyproject.toml b/pyproject.toml index 2279deb24..f5dc82a06 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,6 +54,7 @@ test = [ ] doc = [ "sphinx", + "seed_intersphinx_mapping", "tomli; python_version < '3.11'", "snakeoil~=0.10.4", ]