Skip to content

Commit 5f07abc

Browse files
blink1073blink1073
authored
Add api docs (#1067)
add api docs
1 parent a192ced commit 5f07abc

File tree

10 files changed

+235
-4
lines changed

10 files changed

+235
-4
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,15 @@ jobs:
9393
steps:
9494
- uses: actions/checkout@v3
9595
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
96+
- name: Build API docs
97+
run: |
98+
hatch run docs:api
99+
# If this fails run `hatch run docs:api` locally
100+
# and commit.
101+
git status --porcelain
102+
git status -s | grep "A" && exit 1
103+
git status -s | grep "M" && exit 1
104+
echo "API docs done"
96105
- run: hatch run docs:build
97106

98107
test_without_debugpy:

‎docs/api/ipykernel.comm.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
ipykernel.comm package
2+
======================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: ipykernel.comm.comm
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
14+
.. automodule:: ipykernel.comm.manager
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
Module contents
20+
---------------
21+
22+
.. automodule:: ipykernel.comm
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:

‎docs/api/ipykernel.inprocess.rst‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
ipykernel.inprocess package
2+
===========================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: ipykernel.inprocess.blocking
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
14+
.. automodule:: ipykernel.inprocess.channels
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
20+
.. automodule:: ipykernel.inprocess.client
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
26+
.. automodule:: ipykernel.inprocess.constants
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
.. automodule:: ipykernel.inprocess.ipkernel
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
38+
.. automodule:: ipykernel.inprocess.manager
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
44+
.. automodule:: ipykernel.inprocess.socket
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
Module contents
50+
---------------
51+
52+
.. automodule:: ipykernel.inprocess
53+
:members:
54+
:undoc-members:
55+
:show-inheritance:

‎docs/api/ipykernel.rst‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
ipykernel package
2+
=================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
ipykernel.comm
11+
ipykernel.inprocess
12+
13+
Submodules
14+
----------
15+
16+
17+
.. automodule:: ipykernel.compiler
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
23+
.. automodule:: ipykernel.connect
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
29+
.. automodule:: ipykernel.control
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
35+
.. automodule:: ipykernel.debugger
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
41+
.. automodule:: ipykernel.displayhook
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
47+
.. automodule:: ipykernel.embed
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
53+
.. automodule:: ipykernel.eventloops
54+
:members:
55+
:undoc-members:
56+
:show-inheritance:
57+
58+
59+
.. automodule:: ipykernel.heartbeat
60+
:members:
61+
:undoc-members:
62+
:show-inheritance:
63+
64+
65+
.. automodule:: ipykernel.iostream
66+
:members:
67+
:undoc-members:
68+
:show-inheritance:
69+
70+
71+
.. automodule:: ipykernel.ipkernel
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
77+
.. automodule:: ipykernel.jsonutil
78+
:members:
79+
:undoc-members:
80+
:show-inheritance:
81+
82+
83+
.. automodule:: ipykernel.kernelapp
84+
:members:
85+
:undoc-members:
86+
:show-inheritance:
87+
88+
89+
.. automodule:: ipykernel.kernelbase
90+
:members:
91+
:undoc-members:
92+
:show-inheritance:
93+
94+
95+
.. automodule:: ipykernel.kernelspec
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
101+
.. automodule:: ipykernel.log
102+
:members:
103+
:undoc-members:
104+
:show-inheritance:
105+
106+
107+
.. automodule:: ipykernel.parentpoller
108+
:members:
109+
:undoc-members:
110+
:show-inheritance:
111+
112+
113+
.. automodule:: ipykernel.trio_runner
114+
:members:
115+
:undoc-members:
116+
:show-inheritance:
117+
118+
119+
.. automodule:: ipykernel.zmqshell
120+
:members:
121+
:undoc-members:
122+
:show-inheritance:
123+
124+
Module contents
125+
---------------
126+
127+
.. automodule:: ipykernel
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:

‎docs/api/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ipykernel
2+
=========
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
ipykernel

‎docs/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"sphinx.ext.autodoc",
3535
"sphinx.ext.intersphinx",
3636
"sphinxcontrib_github_alt",
37+
"sphinx_autodoc_typehints",
3738
]
3839

3940
try:

‎docs/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ Most IPython kernel documentation is in the `IPython documentation <https://ipyt
99
Contents:
1010

1111
.. toctree::
12-
:maxdepth: 2
12+
:maxdepth: 1
1313

1414
changelog
15+
API docs <api/modules>
1516

1617

1718
Indices and tables

‎ipykernel/comm/comm.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
class BaseComm(comm.base_comm.BaseComm):
1919
"""The base class for comms."""
2020

21-
kernel: Optional[Kernel] = None
21+
kernel: Optional["Kernel"] = None
2222

2323
def publish_msg(self, msg_type, data=None, metadata=None, buffers=None, **keys):
2424
"""Helper for sending a comm message on IOPub"""

‎ipykernel/embed.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def embed_kernel(module=None, local_ns=None, **kwargs):
2424
The module to load into IPython globals (default: caller)
2525
local_ns : dict, optional
2626
The namespace to load into IPython user namespace (default: caller)
27-
**kwargs : various, optional
27+
kwargs : dict, optional
2828
Further keyword args are relayed to the IPKernelApp constructor,
2929
allowing configuration of the Kernel. Will only have an effect
3030
on the first embed_kernel call for a given process.

‎pyproject.toml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ docs = [
4545
"myst_parser",
4646
"pydata_sphinx_theme",
4747
"sphinxcontrib_github_alt",
48-
"sphinxcontrib-spelling"
48+
"sphinxcontrib-spelling",
49+
"sphinx-autodoc-typehints",
50+
"trio"
4951
]
5052
test = [
5153
"pytest>=7.0",
@@ -82,6 +84,7 @@ path = "ipykernel/_version.py"
8284
features = ["docs"]
8385
[tool.hatch.envs.docs.scripts]
8486
build = "make -C docs html SPHINXOPTS='-W'"
87+
api = "sphinx-apidoc -o docs/api -f -E ipykernel ipykernel/tests ipykernel/inprocess/tests ipykernel/datapub.py ipykernel/pickleutil.py ipykernel/serialize.py ipykernel/gui ipykernel/pylab"
8588

8689
[tool.hatch.envs.test]
8790
features = ["test"]

0 commit comments

Comments
 (0)