documentation.yml

name: Documentation

on:
  push:
    tags:
      - 'v*'
  # Allows to run the workflow manually
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

env:
  CUSTOM_DOMAIN: python-sdk.meilisearch.com

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          lfs: true
      - name: Setup Github Pages
        uses: actions/configure-pages@v5
      - name: Install Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"
      - name: Install pipenv
        run: |
          pip install pipx
          pipx install pipenv
      - name: Install dependencies
        run: |
          pipenv install --dev
          pipenv install sphinx
          pipenv install sphinx_rtd_theme
      - name: Build docs
        run: |
          pipenv run sphinx-apidoc -f -o docs meilisearch/
          pipenv run sphinx-build docs ./docs/_build/html/
        # CNAME file is required for GitHub pages custom domain
      - name: Create CNAME file
        run: |
          echo "$CUSTOM_DOMAIN" > ./docs/_build/html/CNAME
          echo "Created CNAME in ./docs/_build/html/: $CUSTOM_DOMAIN"
      - name: Upload artifacts
        uses: actions/upload-pages-artifact@v3
        with:
          path: "./docs/_build/html"
  deploy:
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4