Tsunami-Simulation/.github/workflows/docs.yml at main · Integer-Ctrl/Tsunami-Simulation · 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
name: Docs

on:
  #push:
  #  branches-ignore:
  #    - '**'
  workflow_dispatch:
  push:
    branches: [ main ]
permissions:
  contents: write

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Requirements
      run: sudo apt-get install doxygen
        && pip3 install sphinx
        && pip3 install sphinx-rtd-theme
        && pip3 install breathe
        && pip3 install sphinx-copybutton
        && pip3 install sphinx-design
    - name: Checkout repo
      uses: actions/checkout@v4.1.0
    - name: Build docs
      run: cd docs_sphinx
        && make clean
        && make html
        && cd _build/html
        && touch .nojekyll
    - name: Deploy to GitHub Pages
      uses: JamesIves/github-pages-deploy-action@v4.5.0
      with:
        folder: docs_sphinx/_build/html # The folder the action should deploy.