docs.yml

name: Documentation

on:
  pull_request:
  push:
    branches:
      - main

jobs:
  check-docstrings:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python 3.10
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"
          cache: 'pip' # caching pip dependencies
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install .[dev]
      - name : Check docstrings
        run : pydocstyle src/ --convention google --count

  build-docs:
    runs-on: ubuntu-22.04
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v3

    - name: Set up Python 3.10
      uses: actions/setup-python@v4
      with:
        python-version: '3.10'

    - name: Install Dependencies
      run: |
        python -m pip install --upgrade pip
        pip install .[dev]

    - name: Generate Documentation
      run: pdoc example --output-dir docs --logo "https://pollen-robotics.github.io/python-template/POLLEN_LOGO.png" --logo-link "https://www.pollen-robotics.com"

    - name: Archive Documentation
      uses: actions/upload-artifact@v4
      with:
        name: documentation
        path: docs/

  publish-docs:
    needs: build-docs
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-22.04
    steps:
    - name: Download Documentation
      uses: actions/download-artifact@v4
      with:
        name: documentation
        path: docs/
      
    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v4
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./docs