ros2_medkit/.github/workflows/docs.yml at main · selfpatch/ros2_medkit · 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
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "src/**"
      - "scripts/**"
      - ".github/workflows/docs.yml"
  pull_request:
    branches: [main]
    paths:
      - "docs/**"
      - "src/**"
      - "scripts/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build-docs:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: "pip"

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y graphviz plantuml doxygen
          pip install -e docs/.[dev]

      - name: Generate Doxygen XML
        working-directory: docs
        run: |
          mkdir -p _build/doxygen/xml
          doxygen Doxyfile

      - name: Generate verification report
        run: python3 scripts/generate_verification.py

      - name: Check links
        working-directory: docs
        run: sphinx-build -b linkcheck . _build/linkcheck

      - name: Build documentation
        working-directory: docs
        run: sphinx-build -b html . _build/html -W --keep-going

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build/html

  deploy-docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-24.04
    needs: build-docs
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4