Skip to content

allow adding a preamble for try_examples #293

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

allow adding a preamble for try_examples #293

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6587c08
optionally allow adding a preamble
keewis May 8, 2025
35958d8
import `new_code_cell`
keewis May 8, 2025
6336869
Merge branch 'main' into preamble
keewis Aug 24, 2025
3e799aa
run `black`
keewis Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion jupyterlite_sphinx/jupyterlite_sphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@
from sphinx.util.fileutil import copy_asset
from sphinx.parsers import RSTParser

from ._try_examples import examples_to_notebook, insert_try_examples_directive
from ._try_examples import (
examples_to_notebook,
insert_try_examples_directive,
new_code_cell,
)

import jupytext
import nbformat
Expand Down Expand Up @@ -816,6 +820,13 @@ def run(self):

if notebook_unique_name is None:
nb = examples_to_notebook(self.content, warning_text=warning_text)
preamble_path = Path("try_examples_preamble.py")
if preamble_path.is_file():
preamble = preamble_path.read_text()
# or raise an error if `preamble` is empty
if preamble:
# insert after the "experimental" warning
nb.cells.insert(1, new_code_cell(preamble))
self.content = None
notebooks_dir = Path(self.env.app.srcdir) / CONTENT_DIR
notebook_unique_name = f"{uuid4()}.ipynb".replace("-", "_")
Expand Down
Loading