1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*
* Copyright (c) Jupyter Development Team.
* Distributed under the terms of the Modified BSD License.
*/
const fs = require('fs');
// Most of the -extension packages are useless as their
// public API is the plugins array. Add them only if they
// export other items.
const packages = [
'application',
'apputils',
'attachments',
'cells',
'codeeditor',
'codemirror',
'completer',
'console',
'coreutils',
'csvviewer',
'debugger',
'docmanager-extension',
'docmanager',
'docregistry',
'documentsearch-extension',
'documentsearch',
'extensionmanager',
'filebrowser',
'fileeditor-extension',
'fileeditor',
'htmlviewer',
'hub-extension',
'imageviewer-extension',
'imageviewer',
'inspector',
'javascript-extension',
'json-extension',
'launcher',
'logconsole-extension',
'logconsole',
'lsp-extension',
'mainmenu-extension',
'mainmenu',
'markdownviewer',
'mathjax-extension',
'nbformat',
'notebook',
'observables',
'outputarea',
'pdf-extension',
'property-inspector',
'rendermime-interfaces',
'rendermime',
'running-extension',
'running',
'services',
'settingeditor',
'settingregistry',
'statedb',
'statusbar',
'terminal',
'toc',
'tooltip',
'translation',
'ui-components',
'vega5-extension'
];
const entryPoints = packages
.flatMap(p => [`packages/${p}/src/index.ts`, `packages/${p}/src/index.tsx`])
.filter(function (path) {
return fs.existsSync(path);
});
const exclude =
packages.flatMap(p => [`packages/${p}/test`]) +
['packages/application-extension'];
module.exports = {
entryPoints,
exclude,
externalSymbolLinkMappings: {
'@codemirror/language': {
LanguageSupport:
'https://codemirror.net/docs/ref/#language.LanguageSupport'
},
'@codemirror/state': {
Extension: 'https://codemirror.net/docs/ref/#state.Extension',
SelectionRange: 'https://codemirror.net/docs/ref/#state.SelectionRange',
StateEffect: 'https://codemirror.net/docs/ref/#state.StateEffect'
},
'@jupyter/ydoc': {
createStandaloneCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/functions/createStandaloneCell.html',
DocumentChange:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/types/DocumentChange.html',
FileChange:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/types/FileChange.html',
IMapChange:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/IMapChange.html',
ISharedAttachmentsCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedAttachmentsCell.html',
ISharedCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/types/ISharedCell.html',
ISharedCodeCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedCodeCell.html',
ISharedDocument:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedDocument.html',
ISharedFile:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedFile.html',
ISharedMarkdownCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedMarkdownCell.html',
ISharedNotebook:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedNotebook-1.html',
ISharedRawCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedRawCell.html',
ISharedText:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/ISharedText.html',
IYText:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/interfaces/IYText.html',
NotebookChange:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/types/NotebookChange.html',
SourceChange:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/types/SourceChange.html',
YCodeCell:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/classes/YCodeCell.html',
YDocument:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/classes/YDocument-1.html',
YFile:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/classes/YFile.html',
YNotebook:
'https://jupyter-ydoc.readthedocs.io/en/latest/api/classes/YNotebook.html'
},
'@lumino/application': {
Application:
'https://lumino.readthedocs.io/en/latest/api/classes/application.Application-1.html',
IPlugin:
'https://lumino.readthedocs.io/en/latest/api/interfaces/application.IPlugin.html'
},
'@lumino/coreutils': {
JSONObject:
'https://lumino.readthedocs.io/en/latest/api/interfaces/coreutils.JSONObject.html',
JSONValue:
'https://lumino.readthedocs.io/en/latest/api/types/coreutils.JSONValue.html',
PartialJSONValue:
'https://lumino.readthedocs.io/en/latest/api/types/coreutils.PartialJSONValue.html',
ReadonlyJSONObject:
'https://lumino.readthedocs.io/en/latest/api/interfaces/coreutils.ReadonlyJSONObject.html',
ReadonlyPartialJSONObject:
'https://lumino.readthedocs.io/en/latest/api/interfaces/coreutils.ReadonlyPartialJSONObject.html',
Token:
'https://lumino.readthedocs.io/en/latest/api/classes/coreutils.Token.html'
},
'@lumino/disposable': {
IDisposable:
'https://lumino.readthedocs.io/en/latest/api/interfaces/disposable.IDisposable.html',
IObservableDisposable:
'https://lumino.readthedocs.io/en/latest/api/interfaces/disposable.IObservableDisposable.html'
},
'@lumino/signaling': {
ISignal:
'https://lumino.readthedocs.io/en/latest/api/interfaces/signaling.ISignal.html',
Signal:
'https://lumino.readthedocs.io/en/latest/api/classes/signaling.Signal-1.html'
},
'@lumino/virtualdom': {
VirtualElement:
'https://lumino.readthedocs.io/en/stable/api/modules/virtualdom.VirtualElement.html',
'VirtualElement.IRenderer':
'https://lumino.readthedocs.io/en/latest/api/types/virtualdom.VirtualElement.IRenderer.html'
},
'@lumino/widgets': {
ContextMenu:
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.ContextMenu-1.html',
'ContextMenu.IOptions':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.ContextMenu.IOptions.html',
DockPanel:
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.DockPanel-1.html',
'DockPanel.IOptions':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.DockPanel.IOptions.html',
Menu: 'https://lumino.readthedocs.io/en/stable/api/classes/widgets.Menu-1.html',
'Menu.IItem':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.Menu.IItem.html',
'Menu.IItemOptions':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.Menu.IItemOptions.html',
'MenuBar.Renderer':
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.MenuBar.Renderer.html',
'MenuBar.IRenderData':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.MenuBar.IRenderData.html',
Panel:
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.Panel-1.html',
PanelLayout:
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.PanelLayout.html',
SplitPanel:
'https://lumino.readthedocs.io/en/latest/api/classes/widgets.SplitPanel-1.html',
TabBar:
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.TabBar-1.html',
'TabBar.IOptions':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.TabBar.IOptions.html',
TabPanel:
'https://lumino.readthedocs.io/en/stable/api/classes/widgets.TabPanel-1.html',
'TabPanel.IOptions':
'https://lumino.readthedocs.io/en/stable/api/interfaces/widgets.TabPanel.IOptions.html',
Widget:
'https://lumino.readthedocs.io/en/latest/api/classes/widgets.Widget-1.html'
},
'@rjsf/utils': {
FieldProps:
'https://rjsf-team.github.io/react-jsonschema-form/docs/advanced-customization/custom-widgets-fields/#field-props'
},
yjs: {
RelativePosition: 'https://docs.yjs.dev/api/relative-positions',
UndoManager: 'https://docs.yjs.dev/api/undo-manager',
Text: 'https://docs.yjs.dev/api/shared-types/y.text',
YText: 'https://docs.yjs.dev/api/shared-types/y.text'
}
},
githubPages: false,
navigationLinks: {
GitHub: 'https://github.com/jupyterlab/jupyterlab',
Jupyter: 'https://jupyter.org'
},
name: '@jupyterlab',
plugin: ['typedoc-plugin-mdn-links'],
out: 'docs/source/api',
readme: 'README.md',
theme: 'default',
titleLink: 'https://jupyterlab.readthedocs.io/en/latest',
tsconfig: 'tsconfigdoc.json'
};
|
