Skip to content

Commit 4abdde1

Browse files
authored
Unpin Spinx now that typehints issue ought to be resolved (#1517)
1 parent 2cf991c commit 4abdde1

5 files changed

Lines changed: 42 additions & 38 deletions

File tree

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: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,145 +16,145 @@ 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.shellchannel
114114
:members:
115-
:undoc-members:
116115
:show-inheritance:
116+
:undoc-members:
117117

118118

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

124124

125125
.. automodule:: ipykernel.subshell
126126
:members:
127-
:undoc-members:
128127
:show-inheritance:
128+
:undoc-members:
129129

130130

131131
.. automodule:: ipykernel.subshell_manager
132132
:members:
133-
:undoc-members:
134133
:show-inheritance:
134+
:undoc-members:
135135

136136

137137
.. automodule:: ipykernel.thread
138138
:members:
139-
:undoc-members:
140139
:show-inheritance:
140+
:undoc-members:
141141

142142

143143
.. automodule:: ipykernel.trio_runner
144144
:members:
145-
:undoc-members:
146145
:show-inheritance:
146+
:undoc-members:
147147

148148

149149
.. automodule:: ipykernel.zmqshell
150150
:members:
151-
:undoc-members:
152151
:show-inheritance:
152+
:undoc-members:
153153

154154
Module contents
155155
---------------
156156

157157
.. automodule:: ipykernel
158158
:members:
159-
:undoc-members:
160159
:show-inheritance:
160+
:undoc-members:

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,12 @@
124124
# If true, keep warnings as "system message" paragraphs in the built documents.
125125
# keep_warnings = False
126126

127+
suppress_warnings = [
128+
# Remove both once fix for https://github.com/ipython/ipython/issues/15202 is released
129+
"sphinx_autodoc_typehints.forward_reference",
130+
"sphinx_autodoc_typehints.guarded_import",
131+
]
132+
127133
# If true, `todo` and `todoList` produce output, else they produce nothing.
128134
todo_include_todos = False
129135

pyproject.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@ Tracker = "https://github.com/ipython/ipykernel/issues"
4343

4444
[project.optional-dependencies]
4545
docs = [
46-
# Sphinx pinned until `sphinx-autodoc-typehints` issue is resolved:
47-
# https://github.com/tox-dev/sphinx-autodoc-typehints/issues/523
48-
"sphinx<8.2.0",
46+
"sphinx",
4947
"myst_parser",
5048
"pydata_sphinx_theme",
5149
"sphinxcontrib_github_alt",

0 commit comments

Comments
 (0)