update sphinx workflow

Author: davidye007

.github/workflows/sphinx.yml

@@ -8,31 +8,31 @@ jobs:
     permissions:
       contents: write
     steps:
-    - uses: actions/checkout@v4
-      with:
-        persist-credentials: false
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.11'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r docs/requirements.txt
-    - name: Install your package
-      run: pip install -e .
-    - name: Build docs with clean rebuild
-      run: |
-        sphinx-build -a -E -b html docs/source docs/build/html
-    - name: Upload artifacts
-      uses: actions/upload-artifact@v4
-      with:
-        name: html-docs
-        path: docs/build/html/
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      if: github.ref == 'refs/heads/main'
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/build/html
-        force_orphan: true
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements.txt
+      - name: Install your package
+        run: pip install -e .
+      - name: Build multiversion docs
+        run: |
+          sphinx-multiversion docs/source docs/build/html
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-docs
+          path: docs/build/html/
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html
+          force_orphan: true

.gitignore

@@ -5,3 +5,4 @@
 build
 pyshred/sst copy.ipynb
 pyshred/sst_figures.ipynb
+docs/_build

docs/requirements.txt

@@ -1,4 +1,5 @@
 sphinx>=8.0
 pydata-sphinx-theme
 myst-parser
-sphinx-design
+sphinx-design
+sphinx-multiversion