summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2021-05-11 23:17:49 +0100
committerAndrew Morgan <andrew@amorgan.xyz>2021-05-26 18:52:49 +0100
commit706f64a5d75e72227bf1f930e700f0d19b7adada (patch)
tree41852ac59e0bbbf49345e936f4525ad24cd3e148
parentAdd a favicon (diff)
downloadsynapse-706f64a5d75e72227bf1f930e700f0d19b7adada.tar.xz
Add github actions workflow to deploy docs to gh-pages
-rw-r--r--.github/workflows/docs.yaml34
1 files changed, 34 insertions, 0 deletions
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
new file mode 100644
index 0000000000..a0eb95b5d0
--- /dev/null
+++ b/.github/workflows/docs.yaml
@@ -0,0 +1,34 @@
+name: Deploy the documentation
+#on:
+#  release:
+#    types: [created]
+
+on:
+  push:
+    branches:
+      - develop
+
+  workflow_dispatch:
+
+jobs:
+  pages:
+    name: GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdbook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.8'
+
+      - name: Build the documentatino
+        run: mdbook build
+
+      - name: Deploy latest documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          keep_files: true
+          publish_dir: ./book
+          destination_dir: ./latest
\ No newline at end of file