pyTorchAutoForge/.github/workflows/docs_pages.yml at develop · PeterCalifano/pyTorchAutoForge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
name: Documentation Pages

on:
  push:
    branches:
      - main
    tags:
      - "v*"
    paths:
      - doc/**
      - pyproject.toml
      - .github/workflows/docs_pages.yml
      - pyTorchAutoForge/**
  pull_request:
    branches:
      - main
    paths:
      - doc/**
      - pyproject.toml
      - .github/workflows/docs_pages.yml
      - pyTorchAutoForge/**
  workflow_dispatch:

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

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip
      - name: Install docs dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -e ".[docs]"
      - name: Build Sphinx site
        if: github.event_name == 'pull_request'
        run: python -m sphinx -b html doc site
      - name: Build versioned Sphinx site
        if: github.event_name != 'pull_request'
        run: bash doc/build_versioned_docs.sh site
      - name: Configure GitHub Pages
        if: github.event_name != 'pull_request'
        uses: actions/configure-pages@v5
      - name: Upload Pages artifact
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy-docs:
    if: github.event_name != 'pull_request'
    needs: build-docs
    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