Skip to content

Commit 65ea686

Browse files
authored
Merge pull request #45 from joelostblom/docs-clarifications
Clarify how to preview locally, view a notebook in fullscreen, and link config docs
2 parents 7ee0c09 + 63c7b6c commit 65ea686

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

docs/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Configuration
22
=============
33

4-
You can provide custom configuration to your JupyterLite deployment.
4+
You can provide `custom configuration <https://jupyterlite.readthedocs.io/en/latest/configuring.html>`_ to your JupyterLite deployment.
55

66
For example, if you want to have bqplot working in this deployment, you need to install the bqplot federated extension
77
and you can serve the bqplot wheel to ``piplite``, this is done by telling your ``conf.py`` where to look for the jupyterlite config:

docs/full.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Fullscreen access
33

44
You can access the JupyterLite deployment that ``jupyterlite-sphinx`` made for you, in fullscreen, following the ``./lite/lab`` and ``./lite/retro`` relative urls:
55

6+
- `JupyterLab <./lite/lab/index.html>`_
7+
- `Retrolab <./lite/retro/index.html>`_
68

7-
`JupyterLab <./lite/lab/index.html>`_
8-
9-
`Retrolab <./lite/retro/index.html>`_
9+
If you want to open a specific notebook in fullscreen JupyterLab/Retrolab you can use the ``path`` URL parameter, e.g. ``./lite/lab/?path=my_noteboook.ipynb``.

docs/installation.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ then you need to add the ``jupyterlite-sphinx`` extension to your ``conf.py`` fi
1616
# And other sphinx extensions
1717
# ...
1818
]
19+
20+
JupyterLite should automatically show up in your built online documentation. To preview it locally, you can navigate to the build directory (e.g. ``_build/html``) and use ``python -m http.server`` to serve the site.

0 commit comments

Comments
 (0)