Merge pull request #389 from Int-Circuit/doxygen

Added updated automatic doxygen build on push + theme to make it fit with docs page
2026-01-08 14:49:58 +01:00 · 2026-01-05 13:15:31 +01:00
parent 765f0087fc 152b20899c
commit 36463542ab
11 changed files with 5309 additions and 446 deletions
--- a/.gitattributes
+++ b/.gitattributes
@@ -0,0 +1 @@
+*.qch filter=lfs diff=lfs merge=lfs -text
--- a/.github/workflows/auto-doxygen.yml
+++ b/.github/workflows/auto-doxygen.yml
@@ -0,0 +1,68 @@
+name: Auto-build doxygen docs
+on:
+  push:
+    branches:
+      - master
+   
+  
+  
+jobs:  
+  doxygen:
+    permissions:
+       contents: write    
+    runs-on: ubuntu-24.04
+    if: github.ref == 'refs/heads/master'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+        show-progress: ''
+    - name: Setup and run doxygen
+      run: sudo apt install doxygen graphviz qhelpgenerator-qt5 -y
+    - name: Set up Git LFS
+      run: |
+          git lfs install
+          git lfs track "*.qch"  
+    - name: Run doxygen
+      run: doxygen Doxyfile
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v8
+      with:
+        token: ${{ secrets.MR_TOKEN }}
+        commit-message: update QCH file
+        committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+        title: Update QCH Help file
+        body: |
+         - Updating QT Help file following commit ${{ github.sha }}.
+         - Auto-generated by [create-pull-request][1]
+
+         [1]: https://github.com/peter-evans/create-pull-request
+        branch: update-qch
+        labels: | 
+          qch
+          cicd
+        delete-branch: true
+        add-paths: doc/*.qch
+    - uses: actions/upload-pages-artifact@v3
+      with: 
+       path: ${{ github.workspace }}/doc/html/
+  deploy:
+    # Add a dependency to the build job
+    needs: doxygen
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
--- a/.gitignore
+++ b/.gitignore
@@ -3,5 +3,7 @@
 # Qt build output
 *.user
 # doxygen Doxyfile output
-doc/
+doc/*
+!doc/QElectroTech.qch
 QElectroTech.tag
+!doc/doc-utils
--- a/.gitmodules
+++ b/.gitmodules
@@ -8,3 +8,6 @@
 	path = elements
 	url = https://github.com/qelectrotech/qelectrotech-elements.git

+[submodule "doxygen-awesome-css"]
+	path = doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
--- a/1193
+++ b/1193
--- a/Doxyfile.bak
+++ b/Doxyfile.bak
--- a/doc/QElectroTech.qch
+++ b/doc/QElectroTech.qch
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:56debcb415a5c3662b26ff8765daed9cd53a4c00f0b679a50160ac20d690fcfb
+size 528789504
--- a/doc/doc-utils/delete_me.css
+++ b/doc/doc-utils/delete_me.css
--- a/doc/doc-utils/delete_me.html
+++ b/doc/doc-utils/delete_me.html
@@ -0,0 +1,18 @@
+<!-- HTML footer for doxygen 1.12.0-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
+  </ul>
+</div>
+<!--END GENERATE_TREEVIEW-->
+<!--BEGIN !GENERATE_TREEVIEW-->
+<hr class="footer"/><address class="footer"><small>
+$generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
+</small></address>
+</div><!-- doc-content -->
+<!--END !GENERATE_TREEVIEW-->
+</body>
+</html>
--- a/doc/doc-utils/header.html
+++ b/doc/doc-utils/header.html
@@ -0,0 +1,88 @@
+<!-- HTML header for doxygen 1.12.0-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<!--BEGIN PROJECT_ICON-->
+<link rel="icon" href="$relpath^$projecticon" type="image/x-icon" />
+<!--END PROJECT_ICON-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<!--BEGIN DISABLE_INDEX-->
+  <!--BEGIN FULL_SIDEBAR-->
+<script type="text/javascript">var page_layout=1;</script>
+  <!--END FULL_SIDEBAR-->
+<!--END DISABLE_INDEX-->
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+<!--BEGIN COPY_CLIPBOARD-->
+<script type="text/javascript" src="$relpath^clipboard.js"></script>
+<!--END COPY_CLIPBOARD-->
+$treeview
+$search
+$mathjax
+$darkmode
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
+<script type="text/javascript">
+    DoxygenAwesomeDarkModeToggle.init()
+</script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
+<script type="text/javascript">
+    DoxygenAwesomeFragmentCopyButton.init()
+</script>
+</head>
+<body>
+<!--BEGIN DISABLE_INDEX-->
+  <!--BEGIN FULL_SIDEBAR-->
+<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
+  <!--END FULL_SIDEBAR-->
+<!--END DISABLE_INDEX-->
+
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr id="projectrow">
+  <!--BEGIN PROJECT_LOGO-->
+  <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></td>
+  <!--END PROJECT_LOGO-->
+  <!--BEGIN PROJECT_NAME-->
+  <td id="projectalign">
+   <div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
+   </div>
+   <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+  </td>
+  <!--END PROJECT_NAME-->
+  <!--BEGIN !PROJECT_NAME-->
+   <!--BEGIN PROJECT_BRIEF-->
+    <td>
+    <div id="projectbrief">$projectbrief</div>
+    </td>
+   <!--END PROJECT_BRIEF-->
+  <!--END !PROJECT_NAME-->
+  <!--BEGIN DISABLE_INDEX-->
+   <!--BEGIN SEARCHENGINE-->
+     <!--BEGIN !FULL_SIDEBAR-->
+    <td>$searchbox</td>
+     <!--END !FULL_SIDEBAR-->
+   <!--END SEARCHENGINE-->
+  <!--END DISABLE_INDEX-->
+ </tr>
+  <!--BEGIN SEARCHENGINE-->
+   <!--BEGIN FULL_SIDEBAR-->
+   <tr><td colspan="2">$searchbox</td></tr>
+   <!--END FULL_SIDEBAR-->
+  <!--END SEARCHENGINE-->
+ </tbody>
+</table>
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->
--- a/1
+++ b/1