Skip to content

Commit 7ad4cc4

Browse files
committed
Updated instructions to build the book, using jupyter book V2 🎉
1 parent 300a524 commit 7ad4cc4

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_build

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,19 @@ Notes de cours pour PSY3018 - Méthodes en neurosciences cognitives
1919
Si vous souhaitez développer et construire les notes de cours PSY3018, vous devez:
2020

2121
- Clonez ce repository
22-
- Exécutez `pip install -r requirements.txt` (il est recommandé d'effectuer cette commande dans un environnement virtuel).
23-
- (Recommendé) Effacez le répertoire `methodes_neurocog/_build/`
24-
- Exécutez `jb build methodes_neurocog/`
22+
- Exécutez `pip install -r requirements.txt` (il est recommandé d'effectuer cette commande dans un environnement virtuel).
23+
- (Recommendé) Effacez le répertoire `_build/`
24+
- On exporte l'URL de base à utiliser: `export BASE_URL="https://methodes-cogneuro.github.io"`
25+
- Exécutez les notebooks (uniquement si vous avez changé le code) `jupyter book build --execute`
26+
- Générer le site en html `jupyter book build --html`
2527

26-
Une version statique html du livre sera générée dans `methodes_neurocog/_build/html/`.
28+
29+
Une version statique html du livre sera générée dans `_build/html/`.
2730

2831
### Hosting the book
2932

3033
The html version of the book is hosted on the `gh-pages` branch of this repo. Navigate to your local build and run,
31-
- `ghp-import -n -p -f methodes_neurocog/_build/html`
34+
- `ghp-import -n -p -f _build/html`
3235

3336
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://jupyterbook.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
3437

0 commit comments

Comments
 (0)