Merge branch 'master' of https://github.com/twguest/phenom

.github/workflows/static.yml

@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# 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:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: 'docs/build/html/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -19,9 +19,9 @@ To check that your instillation has worked, open iPython and try::
 ## Examples
 Phenom has been designed to require minimal knowledge of the XFEL process prior to generating your first pulse.
 
-1. [Getting Started](https://github.com/twguest/phenom/blob/master/docs/build/html/notebooks/sase_model_pt1.ipynb)
-2. [Tutorials](https://github.com/twguest/phenom/blob/master/docs/build/html/notebooks/sase_model_pt2.ipynb).
-3. [Integrating with WPG](https://github.com/twguest/phenom/blob/master/docs/build/html/notebooks/phenom_to_wpg.ipynb).
+1. [Getting Started](https://twguest.github.io/phenom/notebooks/sase_model_pt1.html)
+2. [Tutorials](https://twguest.github.io/phenom/notebooks/sase_model_pt2.ipynb).
+3. [Integrating with WPG](https://twguest.github.io/phenom/notebooks/phenom_to_wpg.ipynb).
 
 More details on generating these pulses can be found in the [documentation](https://twguest.github.io/phenom).