Skip to content

Commit c4fde8f

Browse files
committed
Adding new landing page, kept the toctrees in the main one, but we want to merge the two versions at some point.
1 parent 70d9747 commit c4fde8f

File tree

2 files changed

+94
-1
lines changed

2 files changed

+94
-1
lines changed

index_jb2.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Executable Tutorials
2+
3+
This is meant to demonstrate by example how to deploy tutorial materials. The
4+
examples show common patterns including runnable code, plots, exercises with
5+
solutions, etc.
6+
7+
## How to Run The Code
8+
9+
`````{tab-set}
10+
````{tab-item} Locally with pixi
11+
12+
Clone the repository and launch JupyterLab.
13+
14+
```sh
15+
git clone https://github.com/scientific-python/executable-tutorials
16+
cd executable-tutorials
17+
18+
pixi run start
19+
```
20+
````
21+
22+
````{tab-item} Locally with pip
23+
24+
Clone the repository, create an enviornment, install the requirements, and
25+
launch JupyterLab.
26+
27+
28+
```sh
29+
git clone https://github.com/scientific-python/executable-tutorials
30+
cd executable-tutorials
31+
32+
python -m venv .venv
33+
source .venv/bin/activate
34+
35+
pip install -r requirements.txt
36+
jupyter lab
37+
```
38+
````
39+
40+
````{tab-item} In Cloud with Binder
41+
42+
[Open on Binder][].
43+
44+
````
45+
46+
````{tab-item} JupyterLite (experimental)
47+
48+
[Open with JupyterLite][].
49+
50+
````
51+
`````
52+
53+
Or, instead of _running_ the code, you may view the code and results by
54+
following the links below.
55+
56+
## Example Tutorials
57+
58+
We maintain a collection of example tutorials so showcase some features.
59+
60+
::::{grid} 1 1 2 2
61+
:::{card} Executable Code ✨
62+
:link: ./tutorials/executable/basics.md
63+
Tutorial with basic executable cells.
64+
:::
65+
66+
:::{card} Interactive Matplotlib Figures 🐍
67+
:link: ./tutorials/matplotlib/interactive_mpl.md
68+
Tutorial with interactive matplotlib figures.
69+
:::
70+
71+
:::{card} Static Matplotlib Figures 📑
72+
:link: ./tutorials/matplotlib/static_mpl.md
73+
Tutorial with interactive matplotlib figures.
74+
:::
75+
76+
:::{card} Static Code 📖
77+
:link: ./tutorials/static/static.md
78+
Tutorial with static content, code cells are not executed.
79+
:::
80+
81+
::::
82+
83+
84+
## Contributing documentation
85+
86+
We maintain guideline documents for maintainers of tutorial repositories in our [Maintainers' Guide](./maintainer-guide.md).
87+
We envision this document to be a collection of collective wisdom about maintaining MyST Markdown based executable tutorials.
88+
89+
We also have a document for contributors of this repository in our [Contributors' Guide](./contributing.md).
90+
91+
92+
[Open on Binder]: https://mybinder.org/v2/gh/scientific-python/executable-tutorials/main?urlpath=tree/tutorials/
93+
[Open with JupyterLite]: https://scientific-python.github.io/executable-tutorials/jupyterlite/lab/index.html

myst.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ project:
1010
# To autogenerate a Table of Contents, run "myst init --write-toc"
1111
toc:
1212
# Auto-generated by `myst init --write-toc`
13-
- file: index.md
13+
- file: index_jb2.md
1414
- title: Tutorials
1515
children:
1616
- file: tutorials/executable/basics.md

0 commit comments

Comments
 (0)