Workflow to publish docs on pushes to main

brainglobe · Jul 9, 2024 · 3839f74 · 3839f74
1 parent 780c18e
commit 3839f74
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
@@ -0,0 +1,29 @@
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build_sphinx_docs:
+    name: Build Sphinx Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: neuroinformatics-unit/actions/build_sphinx_docs@main
+        with:
+            check-links: false
+
+  deploy_sphinx_docs:
+    name: Deploy Sphinx Docs
+    needs: build_sphinx_docs
+    permissions:
+      contents: write
+    if: (github.event_name == 'push' || github.event_name == 'tag') && github.ref_name == 'main'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: neuroinformatics-unit/actions/deploy_sphinx_docs@v2
+        with:
+            secret_input: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -59,6 +59,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build
 
 # MkDocs documentation
 /site/

diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
diff --git a/docs/group_layers/index.md → docs/source/group_layers/index.md b/docs/group_layers/index.md → docs/source/group_layers/index.md
diff --git a/docs/index.md → docs/source/index.md b/docs/index.md → docs/source/index.md