Skip to content

Commit 1deb6d0

Browse files
committed
ci: add documentation build check
Add a docs-check workflow, calling the reusable check-library-docs workflow from stm32duino/actions, to build the documentation with Doxygen and MkDocs in strict mode on pull requests and pushes to main that touch the documentation sources. Signed-off-by: Frederic Pillon <frederic.pillon@st.com> Assisted-by: GitHub Copilot:claude-sonnet-5.5
1 parent 4ed4946 commit 1deb6d0

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

‎.github/workflows/docs-check.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Documentation build
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- Doxyfile
7+
- docs/**
8+
- src/**
9+
- mkdocs.yml
10+
- .github/workflows/docs-check.yml
11+
push:
12+
branches:
13+
- main
14+
paths:
15+
- Doxyfile
16+
- docs/**
17+
- src/**
18+
- mkdocs.yml
19+
- .github/workflows/docs-check.yml
20+
21+
permissions:
22+
contents: read
23+
24+
jobs:
25+
build:
26+
uses: stm32duino/actions/.github/workflows/check-library-docs.yml@main

0 commit comments

Comments
 (0)