QuEST/.github/workflows/doc.yml at main · QuEST-Kit/QuEST · 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
# Generates API documentation using doxygen,
# and hosts it on Github using Github Pages
#
# @author Tyson Jones

name: doc


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


on:
  push:
    branches:
      - main
  workflow_dispatch:


# prevent concurrent generation
concurrency:
  group: "pages"
  cancel-in-progress: false


jobs:

  build-doc:
    name: Generate doc
    runs-on: ubuntu-latest

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    env:
      doxy_file: utils/docs/Doxyfile
      doxy_out: Doxygen_doc/html
      build_dir: "build"

    steps:
      - name: Obtain copy of repository
        uses: actions/checkout@main

      - name: Install Graphviz (for circuit diagrams)
        uses: tlylt/install-graphviz@v1

      - name: Generate doc with doxygen
        uses: mattnotmitt/doxygen-action@v1.12.0
        with:
          doxyfile-path: ${{ env.doxy_file }}
          enable-latex: true

      - name: Setup Github Pages
        uses: actions/configure-pages@v5

      - name: Upload doc as artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./${{ env.doxy_out }}

      - name: Deploy doc to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4