File tree Expand file tree Collapse file tree 1 file changed +34
-2
lines changed Expand file tree Collapse file tree 1 file changed +34
-2
lines changed Original file line number Diff line number Diff line change @@ -29,8 +29,6 @@ covering some core features:
29
29
30
30
- Read the [ published examples] [ static site example ] .
31
31
32
- - Open it on [ Binder] [ binder example ] to run the examples in the cloud.
33
-
34
32
- Download and run the examples locally.
35
33
36
34
``` sh
@@ -49,6 +47,40 @@ covering some core features:
49
47
pip install -r requirements.txt
50
48
jupyter lab
51
49
```
50
+ ## Build the site
51
+
52
+ There are currently two distinct technology stacks that support the
53
+ ` executable-tutorials ` paradigm: a legacy sphinx-based static-site generation
54
+ engine, and the newer [ myst] [ myst-org ] project.
55
+ The ` executable-tutorials ` repo contains information about both development
56
+ patterns, and endeavors to serve as a transition guide between technology
57
+ stacks.
58
+
59
+ By default, the necessary tooling for both technology stacks is installed with
60
+ ` pip install -r requirements.txt `
61
+
62
+ ### Build with sphinx
63
+
64
+ ``` bash
65
+ make html
66
+ ```
67
+
68
+ The static site can then be viewed by simply opening the index in any browser,
69
+ for example::
70
+
71
+ ``` bash
72
+ firefox _build/html/index.html
73
+ ```
74
+
75
+ ### Build with ` myst `
76
+
77
+ ``` bash
78
+ myst start --execute
79
+ ```
80
+
81
+ This will execute the notebooks, build the site, and set up a server for rendering
82
+ the site.
83
+ The rendered page can be viewed by opening ` localhost:3000 ` in a browser.
52
84
53
85
## Make Your Own
54
86
You can’t perform that action at this time.
0 commit comments