gh-pages.yml

name: Deploy Sphinx Docs to GitHub Pages

on:
  push:
    branches: [ main ]    

permissions:
  contents: write       

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: |
          pip install Sphinx sphinx_rtd_theme

      - name: Build HTML
        run: sphinx-build -b html source build/html

      - name: Deploy to gh-pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: build/html