Create ghpages.yml

.github/workflows/ghpages.yml

@@ -0,0 +1,63 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: GHPages
+
+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:
+  actions: write
+  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:
+  documenter:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: ['1.10']
+        julia-arch: [x64]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+        exclude:
+          - os: macOS-latest
+            julia-arch: x86
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.julia-version }}
+          arch: ${{ matrix.julia-arch }}
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@v1
+      - run: julia --project docs/make.jl
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'docs/build/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -2,7 +2,7 @@
 
 # Fermions.jl - Toolkit for Interacting Electrons
 
- [![Run tests](https://github.com/abhirup-m/fermions.jl/actions/workflows/runtest.yml/badge.svg)](https://github.com/abhirup-m/fermions.jl/actions/workflows/runtest.yml) [![Docs](https://github.com/abhirup-m/fermions.jl/actions/workflows/builddocs.yml/badge.svg)](https://github.com/abhirup-m/fermions.jl/actions/workflows/builddocs.yml)
+ [![Run tests](https://github.com/abhirup-m/fermions.jl/actions/workflows/runtest.yml/badge.svg)](https://github.com/abhirup-m/fermions.jl/actions/workflows/runtest.yml) [![Docs](https://github.com/abhirup-m/fermions.jl/actions/workflows/builddocs.yml/badge.svg)](https://github.com/abhirup-m/fermions.jl/actions/workflows/builddocs.yml) [![GHPages](https://github.com/abhirup-m/fermions.jl/actions/workflows/ghpages.yml/badge.svg)](https://github.com/abhirup-m/fermions.jl/actions/workflows/ghpages.yml)
 
 **Fermions.jl** is a toolkit for designing and analysing second-quantised many-particle Hamiltonians of electrons, potentially interacting with each other. The main point in designing this library is to abstract away the detailed task of writing matrices for many-body Hamiltonians and operators (for correlations functions) with large Hilbert spaces; **all operators (including Hamiltonians) can be specified using predefined symbols, and the library then provides functions for diagonalising such Hamiltonians and computing observables within the states**. (In case you are not accustomed to using second-quantised operators, check [this brief explanation](#a-brief-explanation-of-second-quantised-operators-for-the-uninitiated).)