docs.yml

name: docs

on:
  push:
    branches:
      - main

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup python
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'
      - name: Install katex
        run: |
          sudo apt update
          sudo apt install -y npm
          npm install -g katex
      - name: Install dependencies
        run: |
          pip install --upgrade pip
          pip install -r ./docs/requirements.txt
          pip install -e .
      - name: Compile Sphinx Docs
        run: |
          cd ./docs/
          make html
      - name: Check GitHub Pages status
        uses: crazy-max/ghaction-github-status@v3.0.0
        with:
          pages_threshold: major_outage
      - name: Deploy to GitHub Pages
        if: success()
        uses: crazy-max/ghaction-github-pages@v3.0.0
        with:
          target_branch: docs
          build_dir: ./docs/build/html
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}