Skip to content

Commit

Permalink
Use and depend on intersphinx_registry for doc building.
Browse files Browse the repository at this point in the history
We try to still work if intersphinx_registry is not importable as it
might not be packaged yet, but it is now avail on conda forge, so it
should not be too hard.
  • Loading branch information
Carreau committed May 29, 2024
1 parent d72dd7f commit 431e31c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ matplotlib
docrepr
prompt_toolkit
ipykernel
stack_data
intersphinx_registry
32 changes: 28 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,36 @@

locals().update(config["sphinx"])

intersphinx_mapping = config["intersphinx_mapping"]
for k, v in intersphinx_mapping.items():
intersphinx_mapping[k] = tuple(
[intersphinx_mapping[k]["url"], intersphinx_mapping[k]["fallback"]]
try:
from intersphinx_registry import get_intersphinx_mapping

intersphinx_mapping = get_intersphinx_mapping(
packages={
"python",
"rpy2",
"jupyterclient",
"jupyter",
"jedi",
"traitlets",
"ipykernel",
"prompt_toolkit",
"ipywidgets",
"ipyparallel",
"pip",
}
)

except ModuleNotFoundError:
# In case intersphinx_registry is not yet packages on current plaform
# as it is quite recent.
print("/!\\ intersphinx_registry not installed, relying on local mapping.")
intersphinx_mapping = config["intersphinx_mapping"]
for k, v in intersphinx_mapping.items():
intersphinx_mapping[k] = tuple(
[intersphinx_mapping[k]["url"], intersphinx_mapping[k]["fallback"]]
)


# numpydoc config
numpydoc_show_class_members = config["numpydoc"][
"numpydoc_show_class_members"
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ black = [
doc = [
"docrepr",
"exceptiongroup",
"intersphinx_registry",
"ipykernel",
"ipython[test]",
"matplotlib",
"setuptools>=18.5",
"sphinx-rtd-theme",
"sphinx>=1.3",
"sphinxcontrib-jquery",
"stack_data",
"tomli ; python_version<'3.11'",
"typing_extensions",
]
Expand Down

0 comments on commit 431e31c

Please sign in to comment.