Add Doxygen docs generation + CI workflow

Author: ramsafin

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'Doxyfile'
+      - 'include/**/*.hpp'
+      - 'src/**/*.cpp'
+
+jobs:
+  generate-and-deploy:
+    name: Build and Deploy Doxygen Docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up CMake + Doxygen dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y doxygen graphviz ninja-build
+
+      - name: Configure project with CMake Preset
+        run: cmake --preset gcc-RelWithDebInfo
+
+      - name: Generate Doxygen documentation
+        run: cmake --build --preset gcc-RelWithDebInfo --target doc_doxygen
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: build/gcc-RelWithDebInfo/docs/html
+          publish_branch: gh-pages
+          force_orphan: true

.gitignore

@@ -48,3 +48,6 @@ conanbuildinfo.*
 # === CTest / testing output ===
 Testing/
 test_output/
+
+# === Docs ===
+docs/

CMakeLists.txt

@@ -91,3 +91,22 @@ install(FILES
   "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
 )
+
+# === Documentation ===
+find_package(Doxygen QUIET)
+
+if(DOXYGEN_FOUND)
+  set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+  set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.generated)
+
+  configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+
+  add_custom_target(doc_doxygen
+    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    COMMENT "Generating API documentation with Doxygen"
+    VERBATIM
+  )
+else()
+  message(STATUS "Doxygen not found. 'doc_doxygen' target will not be available.")
+endif()