Host documentation on GitHub Pages

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  doc:
+    name: Execute and build
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - run: pip install -r requirements.txt
+      - run: jupyter book build . -W
+      - uses: actions/upload-pages-artifact@v1
+        if: always()
+        with:
+          path: ./_build/html
+
+  gh-pages:
+    name: Upload to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+    needs:
+      - doc
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-22.04
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -1,2 +1,3 @@
 .ipynb_checkpoints/
+_build/
 data/

_config.yml

@@ -0,0 +1,19 @@
+title: Solutions to STRON2020 HaSP School
+author: Participants of the STRONG2020 HaSP School
+copyright: "2023"
+
+execute:
+  allow_errors: false
+  execute_notebooks: cache
+  timeout: 600
+
+only_build_toc_files: true
+
+repository:
+  url: https://github.com/ComPWA/strong2020-salamanca
+  path_to_book: .
+  branch: main
+
+sphinx:
+  config:
+    nb_execution_show_tb: True

_toc.yml

@@ -0,0 +1,4 @@
+format: jb-book
+root: README
+chapters:
+  - file: lecture2

lecture2.ipynb

@@ -1,5 +1,13 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "3e84775e",
+   "metadata": {},
+   "source": [
+    "# Lecture 2 - Kinematics"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

requirements.txt

@@ -4,6 +4,7 @@ numpy
 particle
 
 # Developer tools
+jupyter-book
 jupyterlab
 jupyterlab-code-formatter
 pre-commit