Skip to content

Commit 34f509d

Browse files
blink1073willingc
blink1073
and
willingc
authored
Add api docs (#1159)
* add api docs * debug * more debug * try again * try again * try again * deps Co-authored-by: Carol Willing <[email protected]>
1 parent de78cbf commit 34f509d

38 files changed

+762
-78
lines changed

‎.github/workflows/python-tests.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ jobs:
6161
run: |
6262
sudo apt-get update
6363
sudo apt-get install enchant-2 # for spell checking
64+
- name: Build API docs
65+
run: |
66+
hatch run docs:api
67+
# If this fails run `hatch run docs:api` locally
68+
# and commit.
69+
git status --porcelain
70+
git status -s | grep "A" && exit 1
71+
git status -s | grep "M" && exit 1
72+
echo "API docs done"
6473
- run: hatch run docs:build
6574

6675
test_lint:

‎docs/source/api/jupyter_server.auth.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
jupyter\_server.auth package
2+
============================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.auth.authorizer
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
14+
.. automodule:: jupyter_server.auth.decorator
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
20+
.. automodule:: jupyter_server.auth.identity
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
26+
.. automodule:: jupyter_server.auth.login
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
.. automodule:: jupyter_server.auth.logout
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
38+
.. automodule:: jupyter_server.auth.security
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
44+
.. automodule:: jupyter_server.auth.utils
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
Module contents
50+
---------------
51+
52+
.. automodule:: jupyter_server.auth
53+
:members:
54+
:undoc-members:
55+
:show-inheritance:

‎docs/source/api/jupyter_server.base.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
jupyter\_server.base package
2+
============================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.base.handlers
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
14+
.. automodule:: jupyter_server.base.websocket
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
20+
.. automodule:: jupyter_server.base.zmqhandlers
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
Module contents
26+
---------------
27+
28+
.. automodule:: jupyter_server.base
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:

‎docs/source/api/jupyter_server.extension.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
jupyter\_server.extension package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.extension.application
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
14+
.. automodule:: jupyter_server.extension.config
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
20+
.. automodule:: jupyter_server.extension.handler
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
26+
.. automodule:: jupyter_server.extension.manager
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
.. automodule:: jupyter_server.extension.serverextension
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
38+
.. automodule:: jupyter_server.extension.utils
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
Module contents
44+
---------------
45+
46+
.. automodule:: jupyter_server.extension
47+
:members:
48+
:undoc-members:
49+
:show-inheritance:

‎docs/source/api/jupyter_server.files.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
jupyter\_server.files package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.files.handlers
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Module contents
14+
---------------
15+
16+
.. automodule:: jupyter_server.files
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:

‎docs/source/api/jupyter_server.gateway.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
jupyter\_server.gateway package
2+
===============================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.gateway.gateway_client
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
14+
.. automodule:: jupyter_server.gateway.handlers
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
20+
.. automodule:: jupyter_server.gateway.managers
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
Module contents
26+
---------------
27+
28+
.. automodule:: jupyter_server.gateway
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:

‎docs/source/api/jupyter_server.i18n.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
jupyter\_server.i18n package
2+
============================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: jupyter_server.i18n
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

‎docs/source/api/jupyter_server.kernelspecs.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
jupyter\_server.kernelspecs package
2+
===================================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.kernelspecs.handlers
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Module contents
14+
---------------
15+
16+
.. automodule:: jupyter_server.kernelspecs
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:

‎docs/source/api/jupyter_server.nbconvert.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
jupyter\_server.nbconvert package
2+
=================================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.nbconvert.handlers
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Module contents
14+
---------------
15+
16+
.. automodule:: jupyter_server.nbconvert
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:

‎docs/source/api/jupyter_server.prometheus.rst

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

‎docs/source/api/jupyter_server.rst

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
jupyter\_server package
2+
=======================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
jupyter_server.auth
11+
jupyter_server.base
12+
jupyter_server.extension
13+
jupyter_server.files
14+
jupyter_server.gateway
15+
jupyter_server.i18n
16+
jupyter_server.kernelspecs
17+
jupyter_server.nbconvert
18+
jupyter_server.prometheus
19+
jupyter_server.services
20+
jupyter_server.view
21+
22+
Submodules
23+
----------
24+
25+
26+
.. automodule:: jupyter_server.config_manager
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
.. automodule:: jupyter_server.log
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
38+
.. automodule:: jupyter_server.serverapp
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
42+
43+
44+
.. automodule:: jupyter_server.traittypes
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
50+
.. automodule:: jupyter_server.transutils
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
56+
.. automodule:: jupyter_server.utils
57+
:members:
58+
:undoc-members:
59+
:show-inheritance:
60+
61+
Module contents
62+
---------------
63+
64+
.. automodule:: jupyter_server
65+
:members:
66+
:undoc-members:
67+
:show-inheritance:

‎docs/source/api/jupyter_server.services.api.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
jupyter\_server.services.api package
2+
====================================
3+
4+
Submodules
5+
----------
6+
7+
8+
.. automodule:: jupyter_server.services.api.handlers
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Module contents
14+
---------------
15+
16+
.. automodule:: jupyter_server.services.api
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:

‎docs/source/api/jupyter_server.services.config.rst

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

0 commit comments

Comments
 (0)