Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use intersphinx_registry #912

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# pin jinja2 due to broken deprecation used in nbconvert
autodoc-traits
intersphinx-registry
jinja2==3.0.*
matplotlib
myst-nb
Expand Down
18 changes: 11 additions & 7 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
# We load the ipython release info into a dict by explicit execution
from intersphinx_registry import get_intersphinx_mapping

iprelease = {}
exec(
compile(
Expand Down Expand Up @@ -358,13 +360,15 @@


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'ipython': ('https://ipython.readthedocs.io/en/stable/', None),
'pymongo': ('https://pymongo.readthedocs.io/en/stable/', None),
'distributed': ('https://distributed.readthedocs.io/en/stable/', None),
'jupyterclient': ('https://jupyter-client.readthedocs.io/en/stable/', None),
}
intersphinx_mapping = get_intersphinx_mapping(
packages={
'python',
'ipython',
'pymongo',
'distributed',
'jupyterclient',
}
)

import os

Expand Down