Nemotron/.github/workflows/docs-deploy.yml at 443d81ecb740ebe94a3498a44482713d92b5b870 · NVIDIA-NeMo/Nemotron · 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
75
76
77
78
79
80
81
# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Deploy Documentation

on:
  push:
    branches:
      - dev
      - main
    paths:
      - "docs/**"
      - "pyproject.toml"
      - ".github/workflows/docs-deploy.yml"
  workflow_dispatch:

concurrency:
  group: docs-deploy-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: write

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

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          version: "0.9.5"
          enable-cache: true
          cache-dependency-glob: "pyproject.toml"

      - name: Build documentation (dev)
        if: github.ref == 'refs/heads/dev'
        run: DOCS_VERSION=dev uv run --group docs sphinx-build docs docs/_build/html -W --keep-going

      - name: Build documentation (stable)
        if: github.ref == 'refs/heads/main'
        run: DOCS_VERSION=stable uv run --group docs sphinx-build docs docs/_build/html -W --keep-going

      - name: Deploy docs (dev branch)
        if: github.ref == 'refs/heads/dev'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html
          publish_branch: gh-pages
          destination_dir: dev
          keep_files: true
          user_name: "github-actions[bot]"
          user_email: "github-actions[bot]@users.noreply.github.com"
          commit_message: "docs: deploy dev from ${{ github.sha }}"

      - name: Deploy docs (main branch)
        if: github.ref == 'refs/heads/main'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html
          publish_branch: gh-pages
          destination_dir: stable
          keep_files: true
          user_name: "github-actions[bot]"
          user_email: "github-actions[bot]@users.noreply.github.com"
          commit_message: "docs: deploy stable from ${{ github.sha }}"