|
14 | 14 | | `unstable/` | Work-in-progress text-only MyST notebooks (`.md` with `{code-cell}` directives) | |
15 | 15 | | `other/` | Supplementary content (e.g. `dqrobotics.md`) | |
16 | 16 | | `convert_to_myst.py` | Script: converts `basic_lessons/*.ipynb` → `unstable/*.md` | |
17 | | -| `myst.yml` | MyST project config (root): LaTeX macros, TOC, site options | |
18 | | -| `unstable/myst.yml` | MyST project config (unstable): mirrors root with adjusted paths | |
| 17 | +| `myst.yml` | MyST project config (root): LaTeX macros, TOC (including unstable section), site options | |
| 18 | +| `unstable/myst.yml` | Standalone MyST project config for unstable-only builds (optional) | |
19 | 19 | | `build_html.sh` | Build script for `jupyter-book` (legacy pipeline) | |
20 | 20 | | `conf.py` | MyST parser extensions (`dollarmath`) | |
21 | 21 | | `_build/` | Build artifacts (excluded from git via `unstable/.gitignore`) | |
@@ -111,15 +111,20 @@ pip install jupyter-book --pre |
111 | 111 |
|
112 | 112 | ### Build Commands |
113 | 113 |
|
114 | | -**MyST build (unstable/):** |
| 114 | +**MyST build (root — includes all lessons + unstable):** |
115 | 115 | ```bash |
116 | | -cd unstable |
117 | | -myst build --execute --html |
| 116 | +myst build --html |
118 | 117 | ``` |
119 | 118 | - `--execute` runs all code cells and caches results in `_build/execute/` |
120 | 119 | - `--html` produces HTML output in `_build/html/` |
121 | 120 | - Site format (JSON) goes to `_build/site/` |
122 | 121 |
|
| 122 | +**MyST build (unstable only — optional):** |
| 123 | +```bash |
| 124 | +cd unstable |
| 125 | +myst build --execute --html |
| 126 | +``` |
| 127 | + |
123 | 128 | **Legacy jupyter-book build (root):** |
124 | 129 | ```bash |
125 | 130 | chmod +x build_html.sh |
@@ -194,6 +199,6 @@ Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooks |
194 | 199 | 3. Add LaTeX macro raw cell (or markdown cell with `vscode` language metadata) |
195 | 200 | 4. Update `myst.yml` → add new file to `project.toc` list |
196 | 201 | 5. Run `python3 convert_to_myst.py` to regenerate `unstable/` |
197 | | -6. Update `unstable/myst.yml` → add new `.md` file to TOC |
198 | | -7. Test: `cd unstable && myst build --execute --html` |
| 202 | +6. Update `myst.yml` → add new unstable `.md` file to the "Unstable" section in `project.toc` |
| 203 | +7. Test: `myst build --html` from the repository root |
199 | 204 | 8. Open PR with descriptive title and body |
0 commit comments