From 814d00460d401a5a2d5a419117c5eb3bfd4933b0 Mon Sep 17 00:00:00 2001 From: Tilo K Date: Sat, 23 Aug 2025 13:04:12 +0200 Subject: [PATCH] feat: add doxygen --- .github/workflows/doxygen.yaml | 42 ++++++++++++++++++++++++++++++++++ Doxyfile | 5 ++++ 2 files changed, 47 insertions(+) create mode 100644 .github/workflows/doxygen.yaml create mode 100644 Doxyfile diff --git a/.github/workflows/doxygen.yaml b/.github/workflows/doxygen.yaml new file mode 100644 index 0000000..2e50ec7 --- /dev/null +++ b/.github/workflows/doxygen.yaml @@ -0,0 +1,42 @@ +name: Build and Deploy Doxygen + +on: + push: + branches: [main] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Install dependencies + run: | + sudo apt-get update + sudo apt-get install -y doxygen graphviz + + - name: Generate docs + run: doxygen Doxyfile + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/html + + deploy: + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..d847b4f --- /dev/null +++ b/Doxyfile @@ -0,0 +1,5 @@ +OUTPUT_DIRECTORY = docs +GENERATE_HTML = YES +GENERATE_LATEX = NO +INPUT *.c *.h +USE_MDFILE_AS_MAINPAGE = README.md \ No newline at end of file