Skip to content

Commit

Permalink
Add check for broken links in Doxygen generated html docs (#5138)
Browse files Browse the repository at this point in the history
  • Loading branch information
hyoklee authored Nov 27, 2024
1 parent fff75d9 commit 460e70c
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/linkchecker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: linkchecker

on:
workflow_dispatch:
push:
pull_request:
branches: [ develop ]

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref && github.ref || github.run_id }}
cancel-in-progress: true

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: get
uses: actions/checkout@v4

- name: install
run: |
sudo apt update -y
sudo apt install -y libunwind-dev
sudo apt install -y graphviz
sudo apt install -y --no-install-recommends doxygen
sudo apt install -y cmake
sudo apt install -y texlive-full
sudo apt install -y texlive-fonts-extra
sudo apt install -y texlive-latex-extra
pip3 install linkchecker
- name: build
run: |
mkdir build
cd build
cmake -DHDF5_BUILD_DOC:BOOL=ON ..
make doxygen
- name: check
run: |
cd build/hdf5lib_docs/html
linkchecker --check-extern ./index.html

0 comments on commit 460e70c

Please sign in to comment.