File tree Expand file tree Collapse file tree 3 files changed +37
-12
lines changed
Expand file tree Collapse file tree 3 files changed +37
-12
lines changed Original file line number Diff line number Diff line change 99master_doc = 'index'
1010
1111# General information about the project.
12- project = 'test_docs '
12+ project = 'JupyterLite sphinx extension '
Original file line number Diff line number Diff line change 11jupyterlite-sphinx
22==================
33
4- JupyterLab :
5- -----------
4+ Installation :
5+ -------------
66
7- ` JupyterLab < ./lite/lab/index.html >`_
7+ You can install `` jupyterlite-sphinx `` with `` pip ``:
88
9- Retrolab:
10- ---------
9+ .. code-block ::
1110
12- ` Retrolab < ./lite/retro/index.html >`_
11+ pip install jupyterlite-sphinx
1312
14- .. toctree ::
15- :caption: Notebooks rendered with RetroLite:
16- :maxdepth: 2
13+ then you need to add the ``jupyterlite-sphinx `` extension to your ``conf.py `` file of your sphinx docs:
1714
18- NotebookLite
15+ .. code-block :: python
16+
17+ extensions = [
18+ ' jupyterlite_sphinx' ,
19+ # And other extensions
20+ # ...
21+ ]
1922
2023 Replite directive:
2124------------------
2225
23- `jupyterlite-sphinx ` provides a `replite ` directive that allows you to embed a replite console in your docs:
26+ ``jupyterlite-sphinx `` provides a ``replite `` directive that allows you to embed a replite console in your docs.
27+ This directive takes the same options as the ``replite `` package, see https://github.com/jtpio/replite for reference.
2428
2529.. code-block :: rst
2630
@@ -41,3 +45,24 @@ Replite directive:
4145 :height: 600px
4246
4347 print('Hello, World!')
48+
49+ Retrolite directive:
50+ --------------------
51+
52+ ``jupyterlite-sphinx `` provides a ``retrolite `` directive that allows you to embed an entire executable Notebook in your docs.
53+ It takes the name of the Notebook as argument:
54+
55+ .. code-block :: rst
56+
57+ .. retrolite:: my_notebook.ipynb
58+
59+ .. retrolite :: my_notebook.ipynb
60+
61+ JupyterLab and RetroLab deployed for you:
62+ -----------------------------------------
63+
64+ ``jupyterlite-sphinx `` makes a full deployment of JupyterLite for you, you can access the JupyterLab UI and RetroLab UI following the
65+ ``./lite/lab/index.html `` and ``./lite/retro/index.html `` relative URLs:
66+
67+ `JupyterLab <./lite/lab/index.html >`_
68+ `Retrolab <./lite/retro/index.html >`_
File renamed without changes.
You can’t perform that action at this time.
0 commit comments