pl

Author: shubhvjain

.github/workflows/publish_doc.yml

@@ -1,52 +1,36 @@
-name: Publish Docs to GitHub Pages
+# .github/workflows/deploy-docs.yml
+name: Deploy Documentation to GitHub Pages
 
 on:
   push:
     branches:
-      - release  # Only trigger on the release branch
-
-permissions:
-  contents: read
-  pages: write  # Required for GitHub Pages API
-  id-token: write  # Required for authentication
+      - release  # Change this if your default branch is not 'main'
+  workflow_dispatch:
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  build-and-deploy:
+    runs-on: ubuntu-22.04
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
+    - name: Checkout repository
+      uses: actions/checkout@v3
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.11.9'
-      - name: Install dependencies
-        run: |
-            python -m pip install --upgrade pip
-            pip install  .
-            pip install sphinx==7.4.7  # Install Sphinx and theme if needed
-      - name: Move to docs folder
-        run: |
-          cd docs
-      - name: Build Sphinx Docs
-        run: |
-          make html  
-      - name: List files in build directory
-        run: ls -R ./build/html
-      - name: Upload static files as artifact
-        id: deployment
-        uses: actions/upload-pages-artifact@v3 
-        with:
-          path: build/html/
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r docs/source/requirements.txt
+
+    - name: Build documentation
+      run: |
+        sphinx-build docs/source docs/build/html
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html