Skip to content

Fixes documentation build #14104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Feb 28, 2023
Merged

Fixes documentation build #14104

merged 1 commit into from
Feb 28, 2023

Conversation

@brichet
Copy link
Contributor

@brichet brichet commented Feb 28, 2023

This PR fixes the building of documentation, by replacing the deprecated footer_items option by footer_start.

The deprecated warning introduced in pydata-sphinx-theme==0.13.0 makes the test fail.

References

Failing linux-docs in #14026

@jupyterlab-probot
Copy link

jupyterlab-probot bot commented Feb 28, 2023

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link: Binder

@jtpio jtpio added this to the 4.0.0 milestone Feb 28, 2023
jtpio
jtpio approved these changes Feb 28, 2023
View reviewed changes
Copy link
Member

@jtpio jtpio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jtpio jtpio merged commit 82e1a74 into jupyterlab:master Feb 28, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 28, 2023

Benchmark report

The execution time (in milliseconds) are grouped by test file, test type and browser.
For each case, the following values are computed: min <- [1st quartile - median - 3rd quartile] -> max.

The mean relative comparison is computed with 95% confidence.

Results table
Test file large_code_notebook large_md_notebook
open
chromium
actual 755 <- [835 - 857 - 888] -> 954 992 <- [1613 - 1650 - 1696] -> 2036
expected 735 <- [812 - 839 - 867] -> 1518 880 <- [1575 - 1640 - 1678] -> 1878
Mean relative change ⚠️ 1.1% ± 2.3% ⚠️ 1.8% ± 3.0%
switch-from
chromium
actual 738 <- [783 - 804 - 820] -> 891 355 <- [428 - 445 - 480] -> 582
expected 616 <- [765 - 788 - 820] -> 975 341 <- [424 - 447 - 488] -> 592
Mean relative change ⚠️ 1.0% ± 1.5% ⚠️ -0.5% ± 2.9%
switch-to
chromium
actual 1428 <- [1490 - 1516 - 1542] -> 1799 1083 <- [1141 - 1154 - 1173] -> 1300
expected 1378 <- [1460 - 1489 - 1525] -> 1805 1070 <- [1124 - 1139 - 1169] -> 1211
Mean relative change ⚠️ 1.7% ± 1.1% ⚠️ 1.2% ± 0.8%
close
chromium
actual 160 <- [191 - 200 - 209] -> 237 223 <- [277 - 286 - 299] -> 339
expected 159 <- [182 - 193 - 205] -> 236 246 <- [271 - 280 - 297] -> 353
Mean relative change ⚠️ 3.0% ± 2.3% ⚠️ 0.9% ± 1.9%

Changes are computed with expected as reference.

@jupyterlab/[email protected] test:mocha
mocha ./tests/

Waiting for localhost:8888
localhost:8888 is up

Cell memory leaks

Create a code cell Memory change: +151 kB Leak detected: Yes

Leaking objects:

Object # added Retained size increase
ArraySearchMarker 1 +5 B
ContentString 1 +79 B
Detached Text 1 +61 B
FocusTracker 1 +276 B
ObservableList 1 +60 B
OutputArea 1 +1.4 kB
OutputAreaModel 1 +115 B
Promise 1 +24 B
PromiseDelegate 1 +128 B
ResizeHandle 1 +47 B
RestorablePool 1 +304 B
Set 1 +76 B
WidgetTracker 1 +976 B
YArray 1 +164 B
YText 1 +303 B
Detached DOMStringMap 2 +96 B
Detached V8EventHandlerNonNull 2 +80 B
StackItem 2 +976 B
YMap 2 +464 B
ContentType 4 +273 B
DeleteSet 4 +744 B
ContentAny 5 +288 B
DeleteItem 5 +100 B
Detached HTMLCollection 6 +564 B
EventHandler 8 +245 B
ID 10 +320 B
Item 10 +1.46 kB
Detached DOMTokenList 13 +836 B
Map 13 +1.53 kB
Detached Attr 14 +1.01 kB
Detached HTMLDivElement 14 +46.7 kB
Signal 16 +278 B
Detached V8EventListener 263 +23.4 kB
(closure) 265 +35.4 kB
Detached EventListener 265 +42.6 kB
Detached InternalNode 323 +45.1 kB

Leaking collections:

Type Change Preview Size increased at
Array +2 [StackItem, ...] 
UndoManager.afterTransactionHandler  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:5030:15
                                     webpack://jupyterlab/node_modules/lib0/observable.js:73:62                                            
Array.forEach                        <anonymous>                                                                                           
                                     webpack://jupyterlab/node_modules/lib0/observable.js:73:62                                            
Array.<anonymous>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4693:27
                                     webpack://jupyterlab/node_modules/lib0/function.js:19:0                                               
cleanupTransactions                  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4695:62
transact                             http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4810:9 
Doc.transact                         http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:2023:5
Array +10 [Item, ...] 
addStruct                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4268:11
Item.integrate               http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:11054:7
<unknown>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6617:22
Array.forEach                <anonymous>                                                                                           
typeListInsertGenericsAfter  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6590:11
typeListInsertGenerics       http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6677:10
<unknown>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6996:9 
transact                     http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4796:5 
YArray.insert                http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6995:7
Create a markdown cell Memory change: -116 kB Leak detected: No

Leaking objects:

Object # added Retained size increase
ActivityMonitor 1 +450 B
ArraySearchMarker 1 +5 B
AttachmentsModel 1 +199 B
AttachmentsResolver 1 +14 B
ContentString 1 +85 B
Debouncer 1 +3.46 kB
Detached HTMLAnchorElement 1 +288 B
Detached HTMLButtonElement 1 +5.45 kB
Detached HTMLHeadingElement 1 +908 B
Error 1 +3.12 kB
MarkdownCell 1 +4.88 kB
MarkdownCellModel 1 +381 B
Poll 1 +3.76 kB
RenderMimeRegistry 1 +227 B
RenderedMarkdown 1 +66 B
Transaction 1 +860 B
YArray 1 +164 B
YArrayEvent 1 +357 B
YMarkdownCell 1 +137 B
Detached CSSStyleDeclaration 2 +112 B
Detached HTMLElement 2 +288 B
Detached V8EventHandlerNonNull 2 +5.2 kB
ObservableMap 2 +272 B
Promise 2 +3.12 kB
PromiseDelegate 2 +3.33 kB
StackItem 2 +932 B
YText 2 +534 B
DeleteItem 3 +60 B
Detached DOMStringMap 3 +128 B
DeleteSet 4 +700 B
YMap 4 +872 B
ContentAny 5 +524 B
Set 6 +584 B
ContentType 7 +938 B
Detached Text 7 +448 B
Detached HTMLDivElement 10 +30.3 kB
Detached DOMTokenList 13 +808 B
ID 13 +416 B
Item 13 +2.63 kB
EventHandler 14 +448 B
Detached HTMLCollection 17 +1.69 kB
Signal 20 +357 B
Map 21 +10.7 kB
Detached V8EventListener 130 +10.9 kB
Detached EventListener 132 +25.6 kB
Detached InternalNode 162 +28.3 kB

Leaking collections:

Type Change Preview Size increased at
Array +1 [294b557c-f203-4694-806c-6296c4085449, ...] 
                                     webpack://jupyterlab/packages/notebook/src/actions.tsx:2425:37            
Array.forEach                        <anonymous>                                                               
                                     webpack://jupyterlab/packages/notebook/src/actions.tsx:2420:21            
                                     webpack://jupyterlab/packages/notebook/src/actions.tsx:350:12             
                                     webpack://jupyterlab/packages/notebook-extension/src/index.ts:2354:15     
CommandRegistry.execute              http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:5748:33
CommandRegistry._executeKeyBinding   http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:5906:14
CommandRegistry.processKeydownEvent  http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:5846:18
JupyterLab.evtKeydown                http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:4660:23
Array +2 [StackItem, ...] 
UndoManager.afterTransactionHandler  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:5030:15
                                     webpack://jupyterlab/node_modules/lib0/observable.js:73:62                                            
Array.forEach                        <anonymous>                                                                                           
                                     webpack://jupyterlab/node_modules/lib0/observable.js:73:62                                            
Array.<anonymous>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4693:27
                                     webpack://jupyterlab/node_modules/lib0/function.js:19:0                                               
cleanupTransactions                  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4695:62
transact                             http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4810:9 
Doc.transact                         http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:2023:5
Array +13 [Item, ...] 
addStruct                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4268:11
Item.integrate               http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:11054:7
<unknown>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6617:22
Array.forEach                <anonymous>                                                                                           
typeListInsertGenericsAfter  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6590:11
typeListInsertGenerics       http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6677:10
<unknown>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6996:9 
transact                     http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4796:5 
YArray.insert                http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6995:7
Create a raw cell Memory change: +147 kB Leak detected: Yes

Leaking objects:

Object # added Retained size increase
ArraySearchMarker 1 +5 B
ContentString 1 +79 B
Detached CSSStyleDeclaration 1 +56 B
Detached V8EventHandlerNonNull 1 +40 B
YArray 1 +164 B
Detached DOMStringMap 2 +84 B
StackItem 2 +932 B
YText 2 +512 B
DeleteItem 3 +60 B
DeleteSet 4 +700 B
YMap 4 +872 B
ContentAny 5 +524 B
Detached HTMLCollection 5 +456 B
ContentType 7 +938 B
Detached DOMTokenList 9 +540 B
Detached HTMLDivElement 9 +22.5 kB
ID 13 +416 B
Item 13 +2.62 kB
Map 13 +3.93 kB
DOMRectReadOnly 14 +784 B
EventHandler 14 +426 B
(closure) 130 +33.1 kB
Detached V8EventListener 130 +10.9 kB
Detached EventListener 131 +20.4 kB
Detached InternalNode 151 +21.5 kB

Leaking collections:

Type Change Preview Size increased at
Array +1 [099998b2-7afb-4154-ae23-ad12f02fa5fa, ...] 
                                     webpack://jupyterlab/packages/notebook/src/actions.tsx:2425:37            
Array.forEach                        <anonymous>                                                               
                                     webpack://jupyterlab/packages/notebook/src/actions.tsx:2420:21            
                                     webpack://jupyterlab/packages/notebook/src/actions.tsx:350:12             
                                     webpack://jupyterlab/packages/notebook-extension/src/index.ts:2354:15     
CommandRegistry.execute              http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:5748:33
CommandRegistry._executeKeyBinding   http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:5906:14
CommandRegistry.processKeydownEvent  http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:5846:18
JupyterLab.evtKeydown                http://localhost:8888/static/lab/jlab_core.e31d465736fcd6ab8315.js:4660:23
Array +2 [StackItem, ...] 
UndoManager.afterTransactionHandler  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:5030:15
                                     webpack://jupyterlab/node_modules/lib0/observable.js:73:62                                            
Array.forEach                        <anonymous>                                                                                           
                                     webpack://jupyterlab/node_modules/lib0/observable.js:73:62                                            
Array.<anonymous>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4693:27
                                     webpack://jupyterlab/node_modules/lib0/function.js:19:0                                               
cleanupTransactions                  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4695:62
transact                             http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4810:9 
Doc.transact                         http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:2023:5
Array +13 [Item, ...] 
addStruct                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4268:11
Item.integrate               http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:11054:7
<unknown>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6617:22
Array.forEach                <anonymous>                                                                                           
typeListInsertGenericsAfter  http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6590:11
typeListInsertGenerics       http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6677:10
<unknown>                    http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6996:9 
transact                     http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:4796:5 
YArray.insert                http://localhost:8888/static/lab/vendors-node_modules_yjs_dist_yjs_mjs.4fbeace2166db933a6e2.js:6995:7
✔ Adding a cell (232904ms) - Drag and drop a cell

File editor memory leaks

Create a file Memory change: -92.3 kB Leak detected: No

Leaking objects:

Object # added Retained size increase
Detached HTMLUListElement 1 +3.13 kB
Detached V8EventHandlerNonNull 1 +40 B
VirtualElementPass 1 +46 B
Detached HTMLButtonElement 2 +23.7 kB
Detached SVGCircleElement 2 +1.1 kB
LabIcon 2 +1.08 kB
Detached CSSStyleDeclaration 3 +240 B
Detached HTMLLIElement 3 +5.97 kB
Detached NodeList 3 +192 B
NavigationHistoryEntry 3 +720 B
VirtualText 3 +109 B
Detached SVGGElement 4 +2.94 kB
VirtualElement 4 +2.19 kB
Detached SVGAnimatedPreserveAspectRatio 5 +320 B
Detached SVGAnimatedRect 5 +320 B
Detached SVGPathElement 5 +1.77 kB
Detached SVGSVGElement 5 +8.05 kB
Detached HTMLSpanElement 6 +2.33 kB
Detached DOMStringMap 7 +436 B
Detached SVGAnimatedNumber 7 +448 B
Detached Attr 10 +720 B
Detached Text 10 +924 B
Detached HTMLCollection 13 +1.42 kB
Detached DOMTokenList 14 +916 B
Detached HTMLDivElement 15 +33.5 kB
Detached SVGAnimatedString 16 +896 B
Detached SVGAnimatedTransformList 16 +1.02 kB
Detached SVGAnimatedLength 26 +1.66 kB
Detached V8EventListener 130 +10.9 kB
Detached EventListener 131 +20.4 kB
(closure) 138 +6.65 kB
✔ Opening a text file (66551ms)

Notebook memory leaks

Create a notebook Memory change: +33.8 kB Leak detected: Yes

Leaking objects:

Object # added Retained size increase
Detached HTMLUListElement 1 +2.31 kB
Detached V8EventHandlerNonNull 1 +40 B
VirtualElementPass 1 +55 B
Detached HTMLButtonElement 2 +23.5 kB
Detached SVGCircleElement 2 +1.1 kB
HTMLDivElement 2 +264 B
LabIcon 2 +939 B
Detached CSSStyleDeclaration 3 +228 B
Detached HTMLLIElement 3 +6.04 kB
Detached NodeList 3 +216 B
NavigationHistoryEntry 3 +720 B
VirtualText 3 +108 B
VirtualElement 4 +-82 B
Detached SVGAnimatedPreserveAspectRatio 5 +320 B
Detached SVGAnimatedRect 5 +320 B
Detached SVGSVGElement 5 +9.28 kB
Detached HTMLSpanElement 6 +3.03 kB
Detached SVGGElement 6 +4.9 kB
Detached SVGPathElement 7 +2.47 kB
Detached SVGAnimatedNumber 9 +576 B
Detached Attr 10 +720 B
Detached Text 10 +728 B
Detached HTMLCollection 13 +1.36 kB
Detached DOMTokenList 15 +936 B
Detached HTMLDivElement 15 +33.2 kB
Detached SVGAnimatedString 20 +1.12 kB
Detached SVGAnimatedTransformList 20 +1.28 kB
Detached SVGAnimatedLength 26 +1.66 kB
Object 68 +198 kB
Detached V8EventListener 130 +10.9 kB
Detached EventListener 131 +20.4 kB
(closure) 138 +54.4 kB
✔ Opening a notebook (70818ms)

3 passing (6m)
1 pending

@brichet brichet deleted the fix/sphinx_docs branch March 7, 2023 15:57
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@jtpio jtpio jtpio approved these changes

Assignees

@brichet brichet

Labels

documentation

Projects

None yet

Milestone

4.0.0

Development

Successfully merging this pull request may close these issues.

2 participants

@brichet @jtpio