docs.yml

name: Documentation

on:
  pull_request:
    paths:
    - 'docs/**'
    - '.github/workflows/docs.yml'
  push:
    branches:
    - develop
    tags: '[0-9]+.[0-9]+.[0-9]+'
    paths:
    - 'docs/**'
    - 'athena/athena/**' # Function docstrings might change
    - 'assessment_module_manager/assessment_module_manager/**' # Function docstrings might change
    - '.github/workflows/docs.yml'
  release:
    types:
    - created

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

jobs:

  docs:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: ammaraskar/sphinx-action@master
      with:
        docs-folder: "docs/"
        build-command: make html dirhtml
    - uses: actions/upload-artifact@v3
      with:
        name: Documentation
        path: docs/_build/html/
    - uses: actions/upload-pages-artifact@v1
      with:
        path: docs/_build/dirhtml/
      
  # Deployment job
  deploy:
    if: github.ref == 'refs/heads/develop'
    environment:
      name: github-pages
      url: "https://ls1intum.github.io/Athena"
    runs-on: ubuntu-latest
    needs: docs
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1