docs.yml

name: Generate documentation
permissions:
  contents: read

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  docs:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./docs
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Install poetry
        run: pipx install poetry
      - name: Set up Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.13"
          cache: 'poetry'
      - name: Set up cache
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: ./source
          key: 'sphinx-source-cache'
      - 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 -j auto -b html ./ ./_build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
        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