.github/workflows/update-docs.yaml

name: Update Docs and Deploy

on:
  push:
    branches:
      - master
      - main
      - ci-docs

jobs:
  update-docs:
    name: Generate and Deploy Docs
    runs-on: ubuntu-latest

    steps:
    # Checkout the repository
    - name: Checkout Code
      uses: actions/checkout@v3

    # Set up Python environment
    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'

    # Install dependencies
    - name: Install Dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
        pip install sphinx sphinx_book_theme sphinx_markdown_tables recommonmark nbsphinx sphinx_togglebutton hidapi

    # Build the documentation
    - name: Build Docs
      run: |
        cd docs
        make clean html
        mv _build ..

    # Deploy to GitHub Pages
    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: _build/html
        destination_dir: docs
    
    # Remove .nojekyll from root directory if it exists
    - name: Remove .nojekyll file
      run: |
        git config --global user.name "github-actions[bot]"
        git config --global user.email "github-actions[bot]@users.noreply.github.com"
        git fetch origin gh-pages
        git checkout gh-pages
        if [ -f .nojekyll ]; then
          rm .nojekyll
          git add .nojekyll
          git commit -m "Remove .nojekyll file"
          git push origin gh-pages
          echo ".nojekyll file removed"
        else
          echo ".nojekyll file does not exist, skipping."
        fi