build-docs.yaml

name: Build Docs

on:
  push:
    branches: [ "main" ]
  
  # Allows running this workflow manually from the Actions tab
  workflow_dispatch:

# Give the default GITHUB_TOKEN write permission to commit and push 
# the docs files to the repository and allow deployment to GitHub Pages
permissions:
  contents: write
  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

jobs:
  build-docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    
    runs-on: ubuntu-latest
    
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v3
      with:
        python-version: "3.10"
    - name: Install Dependencies
      run: |
        python -m pip install --upgrade pip
        pip install pdoc
    - name: Install Module
      run: |
        pip install .
    - name: Generate Docs
      run: |
        pdoc --docformat google -o ./docs cc.udp
    - name: Commit Docs
      uses: stefanzweifel/git-auto-commit-action@v5
      with:
        commit_message: "ADD: build new docs"
    - name: Setup Pages
      uses: actions/configure-pages@v4
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        # Upload docs repository
        path: "./docs/"
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4