Skip to content

Commit

Permalink
docs: Add intersphinx linkage to dependencies
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
ferringb committed Jan 26, 2024
1 parent 2b66a5a commit 6ba2aca
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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'
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ test = [
]
doc = [
"sphinx",
"seed_intersphinx_mapping",
"tomli; python_version < '3.11'",
"snakeoil~=0.10.4",
]
Expand Down

0 comments on commit 6ba2aca

Please sign in to comment.