build_doc.yml

name: apidocs
on:
  workflow_dispatch:
  push:
    branches:
      - "main"

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Setup python 3.10
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Install requirements for documentation generation
        run: |
          python -m pip install --upgrade pip setuptools wheel
          python -m pip install docutils pydoctor
  
      - name: Generate API documentation with pydoctor
        run: |
  
          # Run pydoctor build
          pydoctor \
              --project-name="${{ github.repository }}" \
              --project-url=https://github.com/$GITHUB_REPOSITORY \
              --html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \
              --project-base-dir="$(pwd)" \
              "${{ github.workspace }}/src/simreaduntil"
  
      - name: Push API documentation to Github Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./apidocs
          commit_message: "Generate API documentation"