pyansys-workflows/.github/workflows/docs.yml at 6ddf3f4a9fbd04f05fa80090d562c42cb37518fe · ansys/pyansys-workflows · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
name: Documentation build

on:
  workflow_dispatch:
  schedule:
    - cron: "0 1 * * *"

env:
  MAIN_PYTHON_VERSION: '3.12'
  DOCUMENTATION_CNAME: 'workflows.docs.pyansys.com'

jobs:
  geometry-mesh:
    uses: ./.github/workflows/geometry-mesh.yml
    secrets: inherit
    with:
      doc-build: true

  geometry-mesh-fluent:
    uses: ./.github/workflows/geometry-mesh-fluent.yml
    secrets: inherit
    with:
      doc-build: true

  # TODO: enable when issues in PyMechanical are resolved
  # geometry-mechanical-dpf:
  #   uses: ./.github/workflows/geometry-mechanical-dpf.yml
  #   secrets: inherit
  #   with:
  #     doc-build: true

  fluent-mechanical:
    uses: ./.github/workflows/fluent-mechanical.yml
    secrets: inherit
    with:
      doc-build: true

  mapdl-dpf:
    uses: ./.github/workflows/mapdl-dpf.yml
    secrets: inherit
    with:
      doc-build: true

  speos-optislang:
    uses: ./.github/workflows/speos-optislang.yml
    secrets: inherit
    with:
      doc-build: true

  maxwell2d-lumerical:
    uses: ./.github/workflows/maxwell2d-lumerical.yml
    secrets: inherit
    with:
      doc-build: true

  compile-docs:
    runs-on: ubuntu-latest
    # TODO: enable when issues in PyMechanical are resolved
    # needs: [geometry-mesh, geometry-mesh-fluent, geometry-mechanical-dpf, fluent-mechanical, speos-optislang]
    needs: [geometry-mesh, geometry-mesh-fluent, fluent-mechanical, mapdl-dpf, speos-optislang]
    steps:
      - name: Checkout code
        uses: actions/checkout@v6.0.2
        with:
          ref: main
          fetch-depth: 0

      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ env.MAIN_PYTHON_VERSION }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r doc/requirements.txt

      - name: Download artifacts for geometry-mesh
        uses: actions/download-artifact@v7
        with:
          name: geometry-mesh-docs
          path: doc/

      - name: Download artifacts for geometry-mesh-fluent
        uses: actions/download-artifact@v7
        with:
          name: geometry-mesh-fluent-docs
          path: doc/

      # TODO: enable when issues in PyMechanical are resolved
      # - name: Download artifacts for geometry-mechanical-dpf
      #   uses: actions/download-artifact@v7
      #   with:
      #     name: geometry-mechanical-dpf-docs
      #     path: doc/

      - name: Download artifacts for fluent-mechanical
        uses: actions/download-artifact@v7
        with:
          name: fluent-mechanical-docs
          path: doc/

      - name: Download artifacts for speos-optislang
        uses: actions/download-artifact@v7
        with:
          name: speos-optislang-docs
          path: doc/

      - name: Download artifacts for pymapdl-dpf
        uses: actions/download-artifact@v7
        with:
          name: mapdl-dpf-docs
          path: doc/

      - name: Download artifacts for maxwell2d-lumerical
        uses: actions/download-artifact@v7
        with:
          name: maxwell2d-lumerical-docs
          path: doc/

      - name: Build the documentation
        run: |
          cd doc
          make html

      - name: Upload the documentation
        uses: actions/upload-artifact@v6
        with:
          name: documentation-html
          path: doc/_build/html/

  publish-docs:
    runs-on: ubuntu-latest
    needs: [compile-docs]
    steps:
      - name: "Download the documentation artifact"
        uses: actions/download-artifact@v7
        with:
          name: documentation-html
          path: doc

      - name: List all files
        run: ls -R .

      - name: "Deploy documentation to gh-pages"
        uses: peaceiris/actions-gh-pages@v4
        with:
          publish_dir: ./doc
          commit_message: "DOC: update documentation"
          github_token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
          cname: ${{ env.DOCUMENTATION_CNAME }}
          force_orphan: true