Skip to content

Commit

Permalink
docs: Update intersphinx location for py3k and automate maintenance
Browse files Browse the repository at this point in the history
seed_intersphinx_mapping will read pyproject collecting the list of
deps and trying to load intersphinx objects from it.  This should
remove the need for us to manage this by hand.

That change will pull in lazy_objects sphinx docs whenever they
write said sphinx docs.

Signed-off-by: Brian Harring <[email protected]>
  • Loading branch information
ferringb committed Jan 26, 2024
1 parent 4490872 commit b1e318b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
9 changes: 8 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"sphinx.ext.ifconfig",
"sphinx.ext.graphviz",
"sphinx.ext.viewcode",
"seed_intersphinx_mapping",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -241,7 +242,13 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"http://docs.python.org/": None}
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
}

# directive to seed_intersphinx_mapping; we use pyproject, thus read that.
pkg_requirements_source = "pyproject"

autodoc_default_flags = [
"members",
"show-inheritance",
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ test = [
"pytest >=6.0",
"pytest-cov",
]
doc = ["sphinx"]
doc = [
"sphinx",
"seed_intersphinx_mapping"
]

[project.urls]
Homepage = "https://github.com/pkgcore/snakeoil"
Expand Down

0 comments on commit b1e318b

Please sign in to comment.