Skip to content

Commit 4bfda80

Browse files
authored
Organize/add docstrings in API docs (#945)
* Remove duplicate documentation src file * Explicitly list API docstrings to include and group under headings * Add @docs blocks for important functions/types currently missing docstrings.
1 parent 035c97a commit 4bfda80

File tree

3 files changed

+148
-3
lines changed

3 files changed

+148
-3
lines changed

docs/src/internals.md

Whitespace-only changes.

docs/src/library/internals.md

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,106 @@
11
# Internals
22

3-
TODO
3+
4+
## Initialization
5+
6+
```@docs
7+
IJulia.init
8+
```
9+
10+
11+
## Cell execution hooks
12+
13+
```@docs
14+
IJulia.pop_posterror_hook
15+
IJulia.pop_postexecute_hook
16+
IJulia.pop_preexecute_hook
17+
IJulia.push_posterror_hook
18+
IJulia.push_postexecute_hook
19+
IJulia.push_preexecute_hook
20+
```
21+
22+
23+
## Messaging
24+
25+
```@docs
26+
IJulia.Msg
27+
IJulia.msg_header
28+
IJulia.send_ipython
29+
IJulia.recv_ipython
30+
IJulia.set_cur_msg
31+
IJulia.send_status
32+
```
33+
34+
35+
## Request handlers
36+
37+
```@docs
38+
IJulia.handlers
39+
IJulia.connect_request
40+
IJulia.execute_request
41+
IJulia.shutdown_request
42+
IJulia.interrupt_request
43+
IJulia.inspect_request
44+
IJulia.history_request
45+
IJulia.complete_request
46+
IJulia.kernel_info_request
47+
IJulia.is_complete_request
48+
```
49+
50+
51+
## Event loop
52+
53+
```@docs
54+
IJulia.eventloop
55+
IJulia.waitloop
56+
```
57+
58+
59+
## IO
60+
61+
```@docs
62+
IJulia.IJuliaStdio
63+
IJulia.capture_stdout
64+
IJulia.capture_stderr
65+
IJulia.watch_stream
66+
```
67+
68+
69+
## Multimedia display
70+
71+
```@docs
72+
IJulia.InlineDisplay
73+
IJulia.InlineIOContext
74+
IJulia.ipy_mime
75+
IJulia.ijulia_mime_types
76+
IJulia.ijulia_jsonmime_types
77+
IJulia.limitstringmime
78+
IJulia.israwtext
79+
IJulia.display_dict
80+
IJulia.display_mimejson
81+
IJulia.display_mimestring
82+
IJulia.register_mime
83+
IJulia.register_jsonmime
84+
```
85+
86+
87+
## Jupyter
88+
89+
```@docs
90+
IJulia.find_jupyter_subcommand
91+
IJulia.launch
92+
```
93+
94+
95+
## Debugging
96+
97+
```@docs
98+
IJulia.set_verbose
99+
```
100+
101+
102+
## Utility
103+
104+
```@docs
105+
IJulia.num_utf8_trailing
106+
```

docs/src/library/public.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,48 @@
11
# Public API
22

33

4-
```@autodocs
5-
Modules = [ IJulia ]
4+
## General
5+
6+
```@docs
7+
IJulia.IJulia
8+
IJulia.inited
9+
IJulia.installkernel
10+
```
11+
12+
13+
## Launching the server
14+
15+
```@docs
16+
IJulia.jupyterlab
17+
IJulia.notebook
18+
IJulia.qtconsole
19+
```
20+
21+
22+
## History
23+
24+
```@docs
25+
IJulia.In
26+
IJulia.Out
27+
IJulia.ans
28+
IJulia.n
29+
IJulia.clear_history
30+
IJulia.history
31+
```
32+
33+
34+
## Cells
35+
36+
```@docs
37+
IJulia.clear_output
38+
IJulia.load
39+
IJulia.load_string
40+
```
41+
42+
43+
## I/O
44+
45+
```@docs
46+
IJulia.readprompt
47+
IJulia.set_max_stdio
648
```

0 commit comments

Comments
 (0)