docs.yml

name: Build Docs

on: [push]

jobs:
  docs:
    runs-on: ubuntu-latest
    # if: github.ref == 'refs/heads/master'
    strategy:
      matrix:
        python-version: ["3.10"]
    steps:
      - uses: actions/checkout@v4
      - name: Setup Python # Set Python version
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install poetry
          poetry config virtualenvs.create false
          python -m pip install --upgrade pip
          # Can't skip optional deps with poetry install -v
          # poetry install -v
          python -m pip install .
      - name: Build docs
        run: |
          python -m pip install -r docs/requirements.txt
          python -m ipykernel install --user --name python --display-name python
          python -m ipykernel install --user --name python3 --display-name python3
          cd docs
          cp ../README.md index.md
          cp ../example.png example.png
          cp ../example2.png example2.png
          # cp ../logo.png logo.png
          cd ..
          mkdocs build
        if : success()
      - name: Deploy docs
        run: |
          mkdocs gh-deploy --clean --force
        # if: success() && github.ref == 'refs/heads/master'

  fix-index:
    needs: docs
    runs-on: ubuntu-latest
    # if: github.ref == 'refs/heads/master'
    strategy:
      matrix:
        python-version: ["3.10"]
    steps:
      - uses: actions/checkout@v4
        with:
          ref: gh-pages
      - name: Fix index.html
        run: |
          echo ':: head of index.html - before ::'
          head index.html
          sed -i '1,5{/^$/d}' index.html
          echo ':: head of index.html - after ::'
          head index.html
        if: success()
      - name: Commit changes
        run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git commit -m "Add changes" -a
        if: success()
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
        if: success()