TransformerEngine

1
# Copyright (c) 2022-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
#
3
# See LICENSE for license information.
4

5
# A workflow to trigger the build of TE documentation on GitHub
6
name: 'Documentation'
7
on:
8
  pull_request:
9
  workflow_dispatch:
10
  workflow_call:
11
jobs:
12
  build_docs:
13
    name: 'Build'
14
    runs-on: ubuntu-latest
15
    steps:
16
      - name: 'Checkout'
17
        uses: actions/checkout@v3
18
      - name: 'Install dependencies'
19
        run: |
20
          pip install sphinx==5.1.1 sphinx_rtd_theme==1.0.0 nbsphinx==0.8.10 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2 astroid==2.15.7
21
          pip install breathe==4.34.0 sphinx-autoapi==2.0.1
22
          sudo apt-get install -y pandoc graphviz doxygen
23
          export GIT_SHA=$(git show-ref --hash HEAD)
24
      - name: 'Build docs'
25
        run: |
26
          doxygen docs/Doxyfile
27
          cd docs
28
          make html
29
      - name: 'Upload docs'
30
        uses: actions/upload-artifact@v3
31
        with:
32
          name: te_docs
33
          path: docs/_build/html
34
          retention-days: 7
35