Skip to content

Commit 21155d5

Browse files
authored
Miscelaneous docs update. (#401)
- remove sphinxcontrib_github_alt as it is unused since 5c51ceb - bump used python in a few places. - and start using intersphinx_registry to simplify managing intersphinx.
1 parent 9a3595e commit 21155d5

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ python:
99
build:
1010
os: ubuntu-22.04
1111
tools:
12-
python: "3.11"
12+
python: "3.12"

docs/conf.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
import shutil
1515
from pathlib import Path
1616

17+
from intersphinx_registry import get_intersphinx_mapping
18+
1719
from jupyter_core.version import __version__, version_info
1820

1921
# If extensions (or modules to document with autodoc) are in another directory,
@@ -33,15 +35,14 @@
3335
"myst_parser",
3436
"sphinx.ext.autodoc",
3537
"sphinx.ext.intersphinx",
36-
"sphinxcontrib_github_alt",
3738
"sphinx_autodoc_typehints",
3839
]
3940

4041
try:
4142
import enchant # noqa: F401
4243

4344
extensions += ["sphinxcontrib.spelling"]
44-
except ImportError:
45+
except ModuleNotFoundError:
4546
pass
4647

4748
github_project_url = "https://github.com/jupyter/jupyter_core"
@@ -294,9 +295,7 @@
294295
# If true, do not generate a @detailmenu in the "Top" node's menu.
295296
# texinfo_no_detailmenu = False
296297

297-
298-
# Example configuration for intersphinx: refer to the Python standard library.
299-
intersphinx_mapping = {"https://docs.python.org/3/": None}
298+
intersphinx_mapping = get_intersphinx_mapping(packages=["python"])
300299

301300

302301
def setup(_):

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ test = [
4747
"pytest-timeout"
4848
]
4949
docs = [
50+
"intersphinx_registry",
5051
"myst-parser",
51-
"sphinxcontrib_github_alt",
52-
"sphinxcontrib_spelling",
52+
"pydata_sphinx_theme",
5353
"sphinx-autodoc-typehints",
54+
"sphinxcontrib_spelling",
5455
"traitlets",
55-
"pydata_sphinx_theme",
5656
]
5757

5858
[project.scripts]

0 commit comments

Comments
 (0)