Skip to content

Use intersphinx registry to avoid out of date links. #563

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

Merged
merged 5 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
7 changes: 7 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

import numpydoc

from intersphinx_registry import get_intersphinx_mapping

# for example.py
sys.path.insert(0, os.path.abspath("."))
# project root
Expand Down Expand Up @@ -137,8 +139,13 @@
# -- Intersphinx setup ----------------------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
<<<<<<< intersphinx_registry

intersphinx_mapping = get_intersphinx_mapping(packages=["python", "numpy", "sklearn"])
=======
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"sklearn": ("https://scikit-learn.org/stable/", None),
}
>>>>>>> main
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ doc = [
'matplotlib>=3.5',
'pydata-sphinx-theme>=0.13.3',
'sphinx>=7',
'intersphinx_registry',
]
test = [
'pytest',
Expand Down
1 change: 1 addition & 0 deletions requirements/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ numpy>=1.22
matplotlib>=3.5
pydata-sphinx-theme>=0.13.3
sphinx>=7
intersphinx_registry
Loading