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/**'
    - '.github/workflows/docs.yml'
# TODO: Add paths where function docstrings might change 'path/**'
  release:
    types:
    - created

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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-22.04
    steps:
      - uses: actions/checkout@v3
      - uses: FelixTJDietrich/sphinx-action@java
        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/
  deploy:
    if: github.ref == 'refs/heads/develop'
    environment:
      name: github-pages
      url: "https://ls1intum.github.io/Hephaestus/"
    runs-on: ubuntu-22.04
    needs: docs
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1