Skip to content
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.

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

ENH: include jupyterlite in the supported extention #1023

Merged
merged 10 commits into from
May 20, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
# "nbsphinx", # Uncomment and comment-out MyST-NB for local testing purposes.
"numpydoc",
"sphinx_togglebutton",
"jupyterlite_sphinx",
]

# -- Internationalization ------------------------------------------------
Expand Down
14 changes: 14 additions & 0 deletions docs/examples/pydata.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,17 @@ data = rng.standard_normal((3, 100))
fig, ax = plt.subplots()
ax.scatter(data[0], data[1], c=data[2], s=3)
```

## Jupyterlite

`jupyterlite-sphinx` brings the power of [JupyterLite](https://jupyterlite.readthedocs.io/en/latest/) to your Sphinx documentation. It makes a full JupyterLite deployment in your docs and provide some utilities for using that deployment easily.

This section demonstrate how it displays in a pydata-sphinx-theme context:

```{replite}
:kernel: python
:height: 600px
:prompt: Try Replite!

print("it's a test")
```
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ doc = [
"sphinx-copybutton",
"sphinx-design",
"sphinx-togglebutton",
"jupyterlite-sphinx",
# Install nbsphinx in case we want to test it locally even though we can't load
# it at the same time as MyST-NB.
"nbsphinx"
Expand Down