Documentation/.github/workflows/docs.yml at 3b0907bce2f23bad591efce07e35da12f70c8fe4 · linksplatform/Documentation · 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
name: Documentation

on:
  push:
    branches: [ main ]
    paths:
      - 'cpp/**'
      - 'doc/**'
      - 'README.md'
      - 'Doxyfile'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [ main ]
    paths:
      - 'cpp/**'
      - 'doc/**'
      - 'README.md'
      - 'Doxyfile'
      - '.github/workflows/docs.yml'

jobs:
  documentation:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      with:
        submodules: recursive

    - name: Setup Doxygen
      run: |
        sudo apt-get update
        sudo apt-get install -y doxygen graphviz

    - name: Clone doxygen-awesome-css
      run: |
        git clone https://github.com/jothepro/doxygen-awesome-css.git

    - name: Generate documentation
      run: |
        doxygen Doxyfile

    - name: Upload documentation artifacts
      uses: actions/upload-artifact@v4
      with:
        name: documentation
        path: docs/html/
        retention-days: 30

    - name: Deploy to GitHub Pages (main branch only)
      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./docs/html
        enable_jekyll: false
        allow_empty_commit: false
        force_orphan: true
        publish_branch: gh-pages
        commit_message: 'Deploy documentation ${{ github.sha }}'