PerforatedAI/.github/workflows/docs.yml at main · PerforatedAI/PerforatedAI

55 lines (46 loc) · 1.3 KB

name: Build and Publish Docs

on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

# Only one Pages deployment at a time; skip queued runs superseded by a newer push
concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install dependencies
        run: |
          # CPU-only torch: the CUDA wheels pull ~2.5 GB of nvidia packages the docs build doesn't need
          python -m pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
          python -m pip install . pdoc

      - name: Generate docs
        run: pdoc perforatedai -o docs -d numpy -t docs-config

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs

  deploy:
    needs: build
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Expand file tree

Search code, repositories, users, issues, pull requests...

Uh oh!

FilesExpand file tree

docs.yml

Latest commit

History

docs.yml

File metadata and controls

Expand file tree