summaryrefslogtreecommitdiff
path: root/.github/workflows/doxygen.yml
diff options
context:
space:
mode:
authorLevent Kaya <levent.kaya@codefirst.io>2024-11-27 10:38:29 +0300
committerLevent Kaya <levent.kaya@codefirst.io>2024-11-27 10:38:29 +0300
commitf17fd7dca109dc543c359b55be748b46e1b79feb (patch)
treec6f8850e6116446a1a8b6951d836273e146b5e79 /.github/workflows/doxygen.yml
parent7803a5e8d3949adffb500b1803b4520bb90b175d (diff)
[ci]
Diffstat (limited to '.github/workflows/doxygen.yml')
-rw-r--r--.github/workflows/doxygen.yml20
1 files changed, 14 insertions, 6 deletions
diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml
index 35834de..d6c85c6 100644
--- a/.github/workflows/doxygen.yml
+++ b/.github/workflows/doxygen.yml
@@ -1,10 +1,15 @@
name: Generate Documentation
on:
+ # Triggers the workflow on push events to the main branch
push:
- branches: [ main ]
+ branches: [ "main" ]
+
+ # Triggers the workflow on pull request events to the main branch
pull_request:
- branches: [ main ]
+ branches: [ "main" ]
+
+ # Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -20,6 +25,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
+ fetch-depth: 0 # This ensures full history for all branches and tags
submodules: recursive
- name: Set up Python
@@ -29,14 +35,15 @@ jobs:
- name: Install dependencies
run: |
+ python -m pip install --upgrade pip
pip install jinja2 Pygments
sudo apt-get update
- sudo apt-get install -y doxygen
+ sudo apt-get install -y doxygen graphviz
- name: Clone m.css
run: |
git clone https://github.com/mosra/m.css.git
-
+
- name: Prepare Doxyfile
run: |
doxygen -g Doxyfile
@@ -48,11 +55,12 @@ jobs:
sed -i 's/EXTRACT_ALL.*=.*/EXTRACT_ALL = YES/g' Doxyfile
sed -i 's/RECURSIVE.*=.*/RECURSIVE = YES/g' Doxyfile
sed -i 's/GENERATE_HTML.*=.*/GENERATE_HTML = NO/g' Doxyfile
-
+ sed -i 's/GENERATE_XML.*=.*/GENERATE_XML = YES/g' Doxyfile
+
- name: Generate Documentation with m.css
run: |
python3 m.css/documentation/doxygen.py Doxyfile
-
+
- name: Setup Pages
uses: actions/configure-pages@v4