|
1 | | -# NESC_3505_textbook |
2 | | -Repository for textbook for NESC 3505, Neural Data Science, at Dalhousie University |
| 1 | +# NESC 3505 Textbook – Neural Data Science |
| 2 | + |
| 3 | +Live site: https://neuraldatascience.io/ |
| 4 | + |
| 5 | +This repository contains the source for the Neural Data Science textbook. The site is built with Jupyter Book (via MyST) and deployed automatically to GitHub Pages. |
| 6 | + |
| 7 | +## How publishing works |
| 8 | + |
| 9 | +- Pushing to the `master` branch triggers a GitHub Actions workflow that: |
| 10 | + - Installs the MyST CLI and Python dependencies |
| 11 | + - Builds the HTML site |
| 12 | + - Deploys it to GitHub Pages |
| 13 | + |
| 14 | +You don’t need to publish locally or commit build artifacts. The CI runner builds from source and uploads the site directly. |
| 15 | + |
| 16 | +## Local development |
| 17 | + |
| 18 | +Option A: Quick static build |
| 19 | + |
| 20 | +1. Build the site |
| 21 | + - `myst build --html` |
| 22 | +2. Open the result |
| 23 | + - `_build/html/index.html` |
| 24 | + |
| 25 | +Option B: Dev server (live preview) |
| 26 | + |
| 27 | +1. If you hit npm EACCES errors on macOS, fix npm cache permissions: |
| 28 | + - `sudo chown -R "$USER:$(id -gn)" ~/.npm` |
| 29 | + - `npm cache verify` |
| 30 | +2. Start the dev server |
| 31 | + - `jupyter book start` |
| 32 | + |
| 33 | +## Project configuration |
| 34 | + |
| 35 | +- Site structure and config are defined in `myst.yml` |
| 36 | +- Additional legacy settings may still exist in `_config.yml`; these are ignored by MyST once `myst.yml` is present |
| 37 | +- The GitHub Actions workflow lives at `.github/workflows/deploy.yml` |
| 38 | + |
| 39 | +## Troubleshooting |
| 40 | + |
| 41 | +- If the Actions run fails at “Upload artifact”, check that the build step created `_build/html`. |
| 42 | +- If the MyST CLI isn’t found locally, install it globally with `npm install -g mystmd` (Node.js ≥ 18 required). |
| 43 | +- To preview just a single change locally, re-run `myst build --html` and refresh your browser on `_build/html/index.html`. |
3 | 44 |
|
4 | | -Formatted version here: [https://neuraldatascience.io/](https://neuraldatascience.io/) |
|
0 commit comments