From 8eb590bad5fe58b42f92a467768fcbbb16253f29 Mon Sep 17 00:00:00 2001 From: MacroMagic Date: Sun, 19 Apr 2026 10:29:17 -0400 Subject: [PATCH] Fix GitHub Pages deployment for Sphinx documentation - Add deploy-docs job to CI workflow - Configure GitHub Pages deployment using official actions - Add .nojekyll file to prevent Jekyll processing - Update README to link to GitHub Pages URL - Add required permissions for Pages deployment --- .github/workflows/ci.yml | 40 ++++++++++++++++++++++++++++++++++++++++ README.rst | 2 +- 2 files changed, 41 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 85b7687..fb1c04f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,6 +8,8 @@ on: permissions: contents: read + pages: write + id-token: write jobs: lint: @@ -64,3 +66,41 @@ jobs: run: | cd docs make html + + deploy-docs: + runs-on: ubuntu-latest + needs: docs + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install dependencies + run: | + pip install -e ".[dev]" + pip install sphinx sphinx-rtd-theme + + - name: Build docs + run: | + cd docs + make html + touch _build/html/.nojekyll + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/_build/html + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.rst b/README.rst index de8894b..96e9df9 100644 --- a/README.rst +++ b/README.rst @@ -19,7 +19,7 @@ the regularized horseshoe prior, which provides strong shrinkage for irrelevant features while preserving truly relevant signals. * Free software: MIT license -* Documentation: https://bayesian-feature-selection.readthedocs.io. +* Documentation: https://macromagic.github.io/bayesian_feature_selection/ Features