docs.yml

name: Deploy Docs

on:
  push:
    branches:
      - main

jobs:
  build-deploy:
    name: Build and deploy docs

    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v2

      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-
            ${{ runner.os }}-

      - name: Install dependencies
        working-directory: docs
        run: make install

      - name: Build and deploy to GitHub Pages
        working-directory: docs
        run: make deploy

      # config for custom domain on gh-pages
      # - name: Create and push CNAME file to gh-pages
      #   run: |
      #     git config --local user.email "actions@github.com"
      #     git config --local user.name "GitHub Actions"
      #     git checkout gh-pages

      #     echo "<domain>" > CNAME

      #     git add CNAME
      #     git commit -m "Add CNAME file"
      #     git push origin gh-pages