Attempting to switch to a github action to render the website.

Author: lunebellec

.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+# This file was created automatically with `jupyter-book init --gh-pages` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
+
+name: Jupyter Book (via myst) GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
+  # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
+  # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
+  BASE_URL: '' # Not required for 'methodes-cogneuro.github.io' domain. Other repos will need to set this!
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install Jupyter Book (via myst)
+        run: npm install -g jupyter-book
+      - name: Build HTML Assets
+        run: jupyter-book build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -20,38 +20,19 @@ Si vous souhaitez développer et construire les notes de cours PSY3018, vous dev
 
 - Clonez ce repository
 - Exécutez `pip install -r requirements.txt` (il est recommandé d'effectuer cette commande dans un environnement virtuel).
-- (Recommendé) Effacez le répertoire `_build/`
-- On exporte l'URL de base à utiliser: `export BASE_URL="https://methodes-cogneuro.github.io"`
+- Modifier le contenu du livre à partir des fichiers `md`
 - Exécutez les notebooks (uniquement si vous avez changé le code) `jupyter book build --execute`
-- Générer le site en html `jupyter book build --html`
+- Si vous souhaitez avoir un apercu du site web: `jupyter book start`
 
 
-Une version statique html du livre sera générée dans `_build/html/`.
-
 ### Hosting the book
-
-The html version of the book is hosted on the `gh-pages` branch of this repo. Navigate to your local build and run,
-- `ghp-import -n -p -f _build/html`
-
-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).
-
-### Generating pdf
-
-The support for pdf generation is experimental with jupyter book, and the output is not perfect. Currently the process looks like:
- * install the depencies described in the section "Building a pdf with latex" in the [jb docs](https://jupyterbook.org/advanced/pdf.html).
- * build latex with individual pages: `jb build methodes_neurocog/ --builder pdflatex --individualpages`. This produces warnings (skip them) and errors. If you ever get stuck in the terminal, leaving the weird latex compilation environment is achieved by pressing `X` (you're welcome).
- * install xetex `sudo apt-get install texlive-xetex`
- * go in the build directory `cd methodes_neurocog/_build/latex`
- * edit manually the `tex` file of the chapter. Replace all `\chapter` by `\section` and add a proper `\chapter` at the beginning. You can also search `Content` and replace by `Table des matières`. I have tried to switch the whole doc in French but without success so far.
- * before adding the chapter title, add the following lines: `\setcounter{chapter}{n} \addtocounter{chapter}{-1}`, where `n` is the number of the chapter.
- * Compile a chapter, e.g. `xelatex cartes_cerebrales.tex`
- * the resulting pdf is mega-huge. So shrink it with `gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.4 -dNOPAUSE -dQUIET -dBATCH -sOutputFile=notes_cours_cartes_cerebrales.pdf -dPDFSETTINGS=/ebook cartes_cerebrales.pdf`
- * Voilà 🎉 🎉 🎉
+- Ouvrir une pull request pour faire des changements.
+- Une fois les changements importés dans `main` une action github va construire le livre automatiquement.
 
 ## Contributors
 
 We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/psy3018/notes_cours_psy3018/graphs/contributors).
 
 ## Credits
 
-This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book). Further credits for the book can be found in the book itself.
+This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/). Further credits for the contributors of the book can be found in the book itself.