ci: build and deploy docs2

Modalities · Jan 15, 2024 · b211c15 · b211c15
1 parent 5e1d971
commit b211c15
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 11 deletions.
diff --git a/.github/workflows/build_and_deploy_documentation.yml b/.github/workflows/build_and_deploy_documentation.yml
@@ -20,17 +20,11 @@ jobs:
       run: |
         sphinx-build -M html docs/source/ docs/build/
         sphinx-apidoc -o docs/source/api src/modalities
-  pages:
-    runs-on: ubuntu-20.04
-    steps:
-    - name : "Deploy Github Pages"
-    - id: deployment
-      uses: sphinx-notes/pages@v3
-      with:
-        publish: false
-    - uses: peaceiris/actions-gh-pages@v3
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
       with:
+        publish_branch: gh-pages
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ${{ steps.deployment.outputs.artifact }}
-
+        publish_dir: docs/build/
+        force_orphan: true
 
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Modalities
 
+Documentation: https://modalities.github.io/modalities/
+
 # Installation
 
 Create conda environment and activate it via