DOC: add preview of AmpForm-DPD model deserialization (#47)

* DX: add Jupyter Lab and related extensions
* DX: avoid duplicate workflow runs per PR
* DX: upload caches in `~/.cache` folder
* DX: set `PYTHONHASHSEED`
* MAINT: add `.virtual_documents` to .gitignore

.cspell.json

@@ -15,6 +15,11 @@
       "addWords": true,
       "name": "physics",
       "path": "./.cspell/physics.txt"
+    },
+    {
+      "addWords": true,
+      "name": "python",
+      "path": "./.cspell/python.txt"
     }
   ],
   "enableFiletypes": ["julia", "quarto"],
@@ -25,6 +30,7 @@
     ".github/workflows",
     ".gitignore",
     ".pre-commit-config.yaml",
+    ".prettierignore",
     ".taplo.toml",
     ".vscode/*.json",
     "json_options.jl",
@@ -42,6 +48,10 @@
     {
       "dictionaries": ["julia", "physics", "project"],
       "languageId": ["julia", "quarto", "text"]
+    },
+    {
+      "dictionaries": ["physics", "project", "python"],
+      "languageId": ["julia", "quarto", "text"]
     }
   ],
   "version": "0.2"

.cspell/physics.txt

@@ -12,4 +12,5 @@ lineshape
 lineshapes
 parametrizations
 recoupling
+recouplings
 Weisskopf

.cspell/project.txt

@@ -1,3 +1,4 @@
+callout
 Mikhasenko
 Misha
 multline

.cspell/python.txt

@@ -0,0 +1,21 @@
+ampform
+aslatex
+figsize
+funcs
+isnan
+Kallen
+lambdify
+linspace
+matplotlib
+meshgrid
+nansum
+numpy
+pathlib
+pcolormesh
+phasespace
+pyplot
+sympy
+tqdm
+xlabel
+xreplace
+ylabel

.github/workflows/docs.yml

@@ -1,5 +1,13 @@
 name: Documentation
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: |-
+    ${{ github.ref != format('refs/heads/{0}', github.event.repository.default_branch) }}
+
+env:
+  PYTHONHASHSEED: "0"
+
 on:
   pull_request:
     branches:
@@ -36,6 +44,16 @@ jobs:
             jupyter-cache
           path: |
             **/.jupyter_cache
+      - name: General caches
+        uses: actions/cache@v4
+        with:
+          key: |
+            home-cache-${{hashFiles('pixi.lock')}}-${{hashFiles('docs/*/*.md')}}
+          restore-keys: |
+            home-cache-${{hashFiles('pixi.lock')}}
+            home-cache
+          path: |
+            ~/.cache
       - run: pixi run doc
       - if: always()
         uses: actions/upload-pages-artifact@v3

.gitignore

@@ -1,5 +1,6 @@
 *.egg-info/
 .ipynb_checkpoints/
 .pixi/
+.virtual_documents/
 _build/
 node_modules/

.prettierignore

@@ -0,0 +1 @@
+*.ipynb

.vscode/settings.json

@@ -8,6 +8,9 @@
   "[markdown]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
+  "[quarto]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
   "[yaml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },