Add documentation from notebooks

.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: [stable]
+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: /${{ github.event.repository.name }}
+
+# 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

.gitignore

@@ -17,3 +17,6 @@ Fig/*
 *.svg
 TODO.txt
 tests/*
+
+# MyST build outputs
+_build

myst.yml

@@ -0,0 +1,15 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  id: 35d0ad15-d16d-4ba6-b6a0-d74bbaa9d6f0
+  # title:
+  # description:
+  # keywords: []
+  # authors: []
+  github: https://github.com/AnMoreau/PyMoosh
+  # To autogenerate a Table of Contents, run "jupyter book init --write-toc"
+site:
+  template: book-theme
+  options:
+    favicon: pymoosh_logo.png
+    logo: pymoosh_logo.png

pyproject.toml

@@ -27,6 +27,7 @@ dependencies = [
 ]
 
 
+
 [project.urls]
 Homepage = "https://github.com/AnMoreau/PyMoosh"
 Repository = "https://github.com/AnMoreau/PyMoosh/stable"
@@ -35,6 +36,17 @@ Documentation = "https://github.com/AnMoreau/PyMoosh#readme"
 [tool.setuptools.packages.find]
 include = ["PyMoosh*"]
 
+
+[project.optional-dependencies]
+docs = [
+    "jupyter-book",
+]
+
+dev = [
+    "pytest",
+]
+
+
 [tool.setuptools]
 include-package-data = true
 zip-safe = false