fix(docs): replace doxygen workflow

with doxygen + breathe + sphinx workflow

Author: fburgerdev

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Generate and Deploy Documentation
+on:
+  push:
+    branches:
+      - develop
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v3
+    - name: Install Dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y doxygen graphviz
+        python -m pip install --upgrade pip
+        pip install -r docs/requirements.txt
+    - name: Generate Doxygen XML
+      run: |
+        mkdir -p build/doxygen
+        doxygen Doxyfile
+    - name: Build Sphinx Documentation
+      run: |
+        sphinx-build -b html docs/ build/sphinx/html
+    - name: Deploy to GitHub Pages
+      if: github.ref == 'refs/heads/main'
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./build/sphinx/html

.github/workflows/doxygen.yml

@@ -1,10 +1,10 @@
-PROJECT_NAME = Parrot
-OUTPUT_DIRECTORY = docs
-GENERATE_HTML = YES
-RECURSIVE = YES
-INPUT = src
-QUIET = YES
-GENERATE_LATEX = NO
-HTML_EXTRA_FILES = docs/theme/doxygen-awesome-darkmode-toggle.js
-HTML_EXTRA_STYLESHEET = docs/theme/doxygen-awesome.css
-HTML_HEADER = docs/theme/header.html
+# Doxyfile Configuration
+
+# Directories to scan for source code
+INPUT = ./src
+
+# Generate XML output for Breathe
+GENERATE_XML = YES
+
+# Optional: Disable HTML output if not needed
+GENERATE_HTML = NO

Doxyfile

@@ -0,0 +1,5 @@
+API Reference
+=============
+
+.. doxygenindex::
+   :project: Parrot

docs/api.rst

@@ -0,0 +1,19 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../src'))
+
+# project
+project = 'Parrot'
+author = 'Florian Burger'
+# extensions
+extensions = [
+  'breathe',
+]
+# config
+breathe_projects = {
+  f"{project}": "../build/doxygen/xml"
+}
+breathe_default_project = f"{project}"
+# theme
+html_theme = 'sphinx_rtd_theme'

docs/conf.py

@@ -0,0 +1,19 @@
+.. MyProject documentation main file, created by
+   sphinx-quickstart on <date>.
+
+Welcome to Parrot's Documentation
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   overview
+   api
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/index.rst

@@ -0,0 +1,6 @@
+Overview
+========
+
+This is an overview of the project architecture, goals, and usage.
+
+You can include any content here: Markdown-like syntax, code snippets, images, etc.

docs/overview.rst

@@ -0,0 +1,3 @@
+sphinx
+breathe
+sphinx-rtd-theme