docs.yml

name: Generate documentation

on:
  push:
    branches:
      - main
  pull_request:
  merge_group:
  workflow_dispatch:

jobs:
  docs:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./docs
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install poetry
        run: |
          pip install poetry
          poetry --version
      - name: Install dependencies and library
        run: poetry install --no-root
      - name: Generate documentation sources
        run: |
          poetry run sphinx-apidoc -f -o ./source ../scaleway-core
          poetry run sphinx-apidoc -f -o ./source ../scaleway
          poetry run sphinx-apidoc -f -o ./source ../scaleway-async
      - name: Generate documentation
        run: poetry run sphinx-build -b html ./ ./_build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
        with:
          publish_branch: docs
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build
          force_orphan: true