sphinx.yml

name: "Sphinx: Render docs"

on:
  pull_request:
    types: [closed]
    branches: [main]
    conditions: # Optional, add this section for successful merge check
      # Ensures the pull request was merged
      github.event.action == 'closed' &&
      github.event.pull_request.merged == true
  push:
      branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.x'

    - name: Install Sphinx & Dependencies
      run: pip install sphinx sphinx_markdown_builder sphinx_rtd_theme
    - name: Install External Requirements
      run: pip install -r requirements.txt
    - name: Build Documentation
      run: cd "$GITHUB_WORKSPACE/docs" && make html
    - name: list
      run: ls "$GITHUB_WORKSPACE/docs/build/html"

    - name: Upload artifacts
      uses: actions/upload-pages-artifact@v3
      with:
        name: html-docs
        path: docs/build/html/

  deploy:
    needs: build
    runs-on: ubuntu-latest

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
      
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
        with:
          token: ${{ github.token }}
          artifact_name: html-docs