build_docs.yml

name: build docs

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-20.04
    permissions:
      contents: write
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v3

      - name: Setup Python
        uses: actions/setup-python@v3
        with:
          python-version: '3.10'
      - name: Install pandoc
        run: sudo apt-get install -y pandoc
      - name: Install Poetry
        uses: snok/install-poetry@v1
      - name: Install package and test dependencies
        run: |
          poetry install --with dev
      - name: build sphinx docs
        run: |
          cd docsrc
          poetry run make github
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/master' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs