You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: web/interactive_terminal/README.md
+9-18
Original file line number
Diff line number
Diff line change
@@ -6,33 +6,24 @@ An interactive REPL to easily try `pandas` in the browser, powered by JupyterLit
6
6
7
7
## Build
8
8
9
-
The interactive REPL is built with the `jupyter lite` CLI.
10
-
11
-
First make sure `jupyterlite` and a kernel are installed:
12
-
13
-
```bash
14
-
python -m pip install jupyterlite-core
15
-
python -m pip install jupyterlite-pyodide-kernel
16
-
```
17
-
18
-
Then in `web/interactive_terminal`, run the following command:
19
-
20
-
```bash
21
-
jupyter lite build
22
-
```
9
+
The interactive REPL can be as a part of the documentation build process
10
+
with Sphinx using the `jupyterlite-sphinx` extension. Please refer to the
11
+
`doc/make.py` file and the [pandas docs development workflow](https://pandas.pydata.org/docs/development/contributing_documentation.html#how-to-build-the-pandas-documentation) for more information.
23
12
24
13
## Configuration
25
14
26
-
This folder contains configuration files for the interactive terminal powered by JupyterLite:
15
+
The `doc/source/`folder contains shared configuration files for the interactive terminal powered by JupyterLite:
27
16
28
17
-`jupyter_lite_config.json`: build time configuration, used when building the assets with the `jupyter lite build` command
29
18
-`jupyter-lite.json` run time configuration applied when launching the application in the browser
30
19
31
-
This interactive `pandas` JupyterLite deployment enables a couple of optimizations to only include the `repl` app in the generated static assets, and disables source maps, which can make the assets smaller and faster to load, at the cost of
32
-
debugging capabilities.
20
+
This interactive `pandas` JupyterLite deployment enables optimizations by removing unused shared packages
21
+
and disabling source maps, which can make the assets smaller and faster to load, at the cost of debugging
22
+
capabilities.
33
23
34
24
To learn more about it, check out the JupyterLite documentation:
**Running it requires a reasonable amount of bandwidth and resources (>70 MiB on the first load), so it may not work properly on all devices or networks.**
8
8
9
+
<!-- This JupyterLite deployment is reused from the one built using the `jupyterlite-sphinx` Sphinx extension
10
+
as a part of the interactive docs utilities in the pandas documentation.
11
+
12
+
To debug locally, replace the URL substring below with "../doc/build/html/lite/<...>", as appropriate. -->
0 commit comments