Skip to content

Commit 05a23ab

Browse files
Carreauianthomas23
authored andcommitted
Rely on intrsphinx_registry to keep intersphinx up to date. (#1290)
1 parent d92f23e commit 05a23ab

File tree

5 files changed

+36
-35
lines changed

5 files changed

+36
-35
lines changed

docs/api/ipykernel.comm.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ Submodules
77

88
.. automodule:: ipykernel.comm.comm
99
:members:
10-
:undoc-members:
1110
:show-inheritance:
11+
:undoc-members:
1212

1313

1414
.. automodule:: ipykernel.comm.manager
1515
:members:
16-
:undoc-members:
1716
:show-inheritance:
17+
:undoc-members:
1818

1919
Module contents
2020
---------------
2121

2222
.. automodule:: ipykernel.comm
2323
:members:
24-
:undoc-members:
2524
:show-inheritance:
25+
:undoc-members:

docs/api/ipykernel.inprocess.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,49 +7,49 @@ Submodules
77

88
.. automodule:: ipykernel.inprocess.blocking
99
:members:
10-
:undoc-members:
1110
:show-inheritance:
11+
:undoc-members:
1212

1313

1414
.. automodule:: ipykernel.inprocess.channels
1515
:members:
16-
:undoc-members:
1716
:show-inheritance:
17+
:undoc-members:
1818

1919

2020
.. automodule:: ipykernel.inprocess.client
2121
:members:
22-
:undoc-members:
2322
:show-inheritance:
23+
:undoc-members:
2424

2525

2626
.. automodule:: ipykernel.inprocess.constants
2727
:members:
28-
:undoc-members:
2928
:show-inheritance:
29+
:undoc-members:
3030

3131

3232
.. automodule:: ipykernel.inprocess.ipkernel
3333
:members:
34-
:undoc-members:
3534
:show-inheritance:
35+
:undoc-members:
3636

3737

3838
.. automodule:: ipykernel.inprocess.manager
3939
:members:
40-
:undoc-members:
4140
:show-inheritance:
41+
:undoc-members:
4242

4343

4444
.. automodule:: ipykernel.inprocess.socket
4545
:members:
46-
:undoc-members:
4746
:show-inheritance:
47+
:undoc-members:
4848

4949
Module contents
5050
---------------
5151

5252
.. automodule:: ipykernel.inprocess
5353
:members:
54-
:undoc-members:
5554
:show-inheritance:
55+
:undoc-members:

docs/api/ipykernel.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,115 +16,115 @@ Submodules
1616

1717
.. automodule:: ipykernel.compiler
1818
:members:
19-
:undoc-members:
2019
:show-inheritance:
20+
:undoc-members:
2121

2222

2323
.. automodule:: ipykernel.connect
2424
:members:
25-
:undoc-members:
2625
:show-inheritance:
26+
:undoc-members:
2727

2828

2929
.. automodule:: ipykernel.control
3030
:members:
31-
:undoc-members:
3231
:show-inheritance:
32+
:undoc-members:
3333

3434

3535
.. automodule:: ipykernel.debugger
3636
:members:
37-
:undoc-members:
3837
:show-inheritance:
38+
:undoc-members:
3939

4040

4141
.. automodule:: ipykernel.displayhook
4242
:members:
43-
:undoc-members:
4443
:show-inheritance:
44+
:undoc-members:
4545

4646

4747
.. automodule:: ipykernel.embed
4848
:members:
49-
:undoc-members:
5049
:show-inheritance:
50+
:undoc-members:
5151

5252

5353
.. automodule:: ipykernel.eventloops
5454
:members:
55-
:undoc-members:
5655
:show-inheritance:
56+
:undoc-members:
5757

5858

5959
.. automodule:: ipykernel.heartbeat
6060
:members:
61-
:undoc-members:
6261
:show-inheritance:
62+
:undoc-members:
6363

6464

6565
.. automodule:: ipykernel.iostream
6666
:members:
67-
:undoc-members:
6867
:show-inheritance:
68+
:undoc-members:
6969

7070

7171
.. automodule:: ipykernel.ipkernel
7272
:members:
73-
:undoc-members:
7473
:show-inheritance:
74+
:undoc-members:
7575

7676

7777
.. automodule:: ipykernel.jsonutil
7878
:members:
79-
:undoc-members:
8079
:show-inheritance:
80+
:undoc-members:
8181

8282

8383
.. automodule:: ipykernel.kernelapp
8484
:members:
85-
:undoc-members:
8685
:show-inheritance:
86+
:undoc-members:
8787

8888

8989
.. automodule:: ipykernel.kernelbase
9090
:members:
91-
:undoc-members:
9291
:show-inheritance:
92+
:undoc-members:
9393

9494

9595
.. automodule:: ipykernel.kernelspec
9696
:members:
97-
:undoc-members:
9897
:show-inheritance:
98+
:undoc-members:
9999

100100

101101
.. automodule:: ipykernel.log
102102
:members:
103-
:undoc-members:
104103
:show-inheritance:
104+
:undoc-members:
105105

106106

107107
.. automodule:: ipykernel.parentpoller
108108
:members:
109-
:undoc-members:
110109
:show-inheritance:
110+
:undoc-members:
111111

112112

113113
.. automodule:: ipykernel.trio_runner
114114
:members:
115-
:undoc-members:
116115
:show-inheritance:
116+
:undoc-members:
117117

118118

119119
.. automodule:: ipykernel.zmqshell
120120
:members:
121-
:undoc-members:
122121
:show-inheritance:
122+
:undoc-members:
123123

124124
Module contents
125125
---------------
126126

127127
.. automodule:: ipykernel
128128
:members:
129-
:undoc-members:
130129
:show-inheritance:
130+
:undoc-members:

docs/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
from pathlib import Path
1616
from typing import Any
1717

18+
from intersphinx_registry import get_intersphinx_mapping
19+
1820
# If extensions (or modules to document with autodoc) are in another directory,
1921
# add these directories to sys.path here. If the directory is relative to the
2022
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -303,11 +305,9 @@
303305

304306

305307
# Example configuration for intersphinx: refer to the Python standard library.
306-
intersphinx_mapping = {
307-
"python": ("https://docs.python.org/3/", None),
308-
"ipython": ("https://ipython.readthedocs.io/en/latest", None),
309-
"jupyter": ("https://jupyter.readthedocs.io/en/latest", None),
310-
}
308+
309+
310+
intersphinx_mapping = get_intersphinx_mapping(packages={"ipython", "python", "jupyter"})
311311

312312

313313
def setup(app):

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ docs = [
5050
"sphinxcontrib_github_alt",
5151
"sphinxcontrib-spelling",
5252
"sphinx-autodoc-typehints",
53+
"intersphinx_registry",
5354
"trio"
5455
]
5556
test = [

0 commit comments

Comments
 (0)