documentation.yaml

name: Docs
on:
  push:
    branches:
      - "main"  # only deploy on main
#  pull_request: {}
  workflow_dispatch: {}

permissions:
  contents: read
  pages: write
  id-token: write


# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

env:
  DOES_PROJECT_DIR: ${{ github.workspace }}/demo_project


jobs:
  docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      #----------------------------------------------
      # checkout repo and setup python + poetry
      #----------------------------------------------
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
           python-version: '3.9'
      - uses: snok/install-poetry@v1
        with:
          version: 1.4.0
          virtualenvs-create: true
          virtualenvs-in-project: true
          installer-parallel: true
      #----------------------------------------------
      # install dependencies
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
        working-directory: ./doespy
      - name: Install project
        run: poetry install --no-interaction
        working-directory: ./doespy
      #----------------------------------------------
      # run sphinx build
      #----------------------------------------------
      - name: Run Sphinx Build
        run: |
          source ./doespy/.venv/bin/activate
          sphinx-build docs/source _build

      #------------------------
      # deploy to github pages
      #------------------------
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          # Upload entire repository
          path: './_build'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1
      #----------------------------------------------
      # deploy to github pages -> only the main branch
      #----------------------------------------------
      #- name: Deploy
      #  uses: peaceiris/actions-gh-pages@v3
      #  if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
      #  with:
      #    publish_branch: gh-pages
      #    github_token: ${{ secrets.GITHUB_TOKEN }}
      #    publish_dir: _build/
      #    force_orphan: true