Merge pull request #56 from kiliczeliha/my-feature

Update github pages docs deploy workflow

Author: kiliczeliha

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,55 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches: [testing]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build documentation
+        run: sphinx-build -b html docs docs/_build/html
+
+      - name: Disable Jekyll
+        run: touch docs/_build/html/.nojekyll
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -15,3 +15,6 @@ arxiv/
 
 .mat
 
+docs/_build
+deployments/
+

docs/README.txt

@@ -132,3 +132,20 @@ Adding a new sidebar entry (a new documentation page)
   Do not edit import_docx.py for hand-written pages; import_docx only overwrites
   the section files it knows about. Keep standalone guides as separate .rst
   files and list them only in index.rst.
+
+
+Publishing on GitHub Pages 
+---------------------------------------
+Live preview (after workflow + Pages are enabled on the branch):
+  https://kiliczeliha.github.io/SPARTAN/
+
+Sources live in this docs/ folder. HTML under docs/_build/ is generated locally
+and in CI; do not commit docs/_build/ (see repo .gitignore).
+
+Updates: push to branch my-feature on your fork; Actions rebuilds the site.
+Manual rebuild: GitHub → Actions → "Deploy Documentation to GitHub Pages" → Run workflow.
+
+Unpublish or freeze:
+  - Take site offline: fork Settings → Pages → Unpublish.
+  - Stop automatic updates: edit .github/workflows/deploy-documentation.yml
+    (e.g. workflow_dispatch only) or disable/delete that workflow.