Skip to content

Commit f590cc7

Browse files
authored
Doc fix (#9)
* Fix upload path * Rename * Use Doxygen v1.14.0
1 parent a51cff1 commit f590cc7

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

.github/workflows/docs.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,22 @@ concurrency:
99
jobs:
1010
build-docs:
1111
name: Build Documentation
12-
runs-on: ubuntu-24.04
12+
runs-on: ubuntu-latest
1313
steps:
1414
- name: Checkout
1515
uses: actions/checkout@v2
16-
- name: Doxygen
17-
uses: mattnotmitt/[email protected]
18-
with: { working-directory: docs }
16+
- name: Install Doxygen
17+
uses: ssciwr/doxygen-install@v1
18+
with: { version: "1.14.0" }
19+
- name: Build
20+
run: cd docs && doxygen
1921
- name: Configure Pages
2022
uses: actions/configure-pages@v5
2123
- name: Upload Generated Docs
2224
uses: actions/upload-pages-artifact@v3
23-
with: { path: docs/output }
25+
with: { path: docs/output/html }
2426
deploy:
27+
name: Deploy Documentation
2528
needs: build-docs
2629
permissions:
2730
pages: write

docs/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
PROJECT_NAME = LiveKit ESP-32 SDK
1+
PROJECT_NAME = LiveKit ESP32 SDK
22
OUTPUT_DIRECTORY = ./output
33
OPTIMIZE_OUTPUT_FOR_C = YES
44
WARN_IF_UNDOCUMENTED = YES

0 commit comments

Comments
 (0)