deploy_docs.yml

# This is a basic workflow to help you get started with Actions

name: Build and deploy website

# Controls when the workflow will run
on:
  # Triggers the workflow on push events but only for the "main" branch
  push:
    branches: [ "main" ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build-and-deploy"
  build-and-deploy:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:

      - name: Clone acquire-docs repo
        uses: actions/checkout@v4
        with:
          path: acquire-docs  # place in a named directory

      - uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      - run: pip install -r acquire-docs/requirements.txt

      - name: Generate downloadable scripts
        run: |
          cd acquire-docs
          bash .github/workflows/convert.sh

      - name: Clone acquire-python repo
        uses: actions/checkout@v4
        with:
          path: acquire-python  # place in a named directory
          repository: acquire-project/acquire-python

      - name: Install acquire-python  # For collecting the API reference
        run: |
          cd acquire-python
          git submodule update --init --recursive
          python -m pip install -e .

      - name: Build website
        run: |
          cd acquire-docs
          mkdocs build

      - name: Deploy docs
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # external_repository: acquire/acquire-docs.github.io
          publish_dir: acquire-docs/site
          publish_branch: gh-pages
          destination_dir: dev
          # cname: acquire.org