Skip to content

Add Myst (new tech stack) workflow #50

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,19 @@ jobs:

- name: Build static site
run: pixi run build

myst_build:
name: Build and execute static site with myst
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup environment
run: pip install -r requirements.txt
- name: Build site with execution
run: |
myst build --execute 2>&1 |tee /tmp/mystbuild.log
if grep -q "Traceback .most recent call last." /tmp/mystbuild.log; then
exit 1;
else
exit 0;
fi
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,40 @@ covering some core features:
pip install -r requirements.txt
jupyter lab
```
## Build the site

There are currently two distinct technology stacks that support the
`executable-tutorials` paradigm: a legacy sphinx-based static-site generation
engine, and the newer [myst][myst-org] project.
The `executable-tutorials` repo contains information about both development
patterns, and endeavors to serve as a transition guide between technology
stacks.

By default, the necessary tooling for both technology stacks is installed with
`pip install -r requirements.txt`

### Build with sphinx

```bash
make html
```

The static site can then be viewed by simply opening the index in any browser,
for example::

```bash
firefox _build/html/index.html
```

### Build with `myst`

```bash
myst start --execute
```

This will execute the notebooks, build the site, and set up a server for rendering
the site.
The rendered page can be viewed by opening `localhost:3000` in a browser.

## Make Your Own

Expand Down
27 changes: 27 additions & 0 deletions myst.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# See docs at: https://mystmd.org/guide/frontmatter
version: 1
project:
id: 9db2473e-461d-4266-86fa-a2a0ea3eb2c9
title: executable-tutorials
description: Executable tutorials for Scientific Python
keywords: []
authors: [Scientific Python Developers]
github: https://github.com/scientific-python/executable-tutorials
# To autogenerate a Table of Contents, run "myst init --write-toc"
toc:
# Auto-generated by `myst init --write-toc`
- file: index.md
- title: Tutorials
children:
- file: tutorials/executable/basics.md
- file: tutorials/matplotlib/interactive_mpl.md
- file: tutorials/matplotlib/static_mpl.md
- file: tutorials/static/static.md
- file: contributing.md
- file: maintainers.md

site:
template: book-theme
# options:
# favicon: favicon.ico
# logo: site_logo.png
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ nbval
pytest-custom_exit_code
jupytext
jupyterlab-myst
# For myst stack
mystmd
jupyter