Initiating some documentation using Doxygen & Sphinx

Author: Lucas-C

.github/workflows/unix.yml

@@ -10,7 +10,7 @@ jobs:
   formatting:
     runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Install clang-format
         env:
@@ -135,3 +135,29 @@ jobs:
       - name: Run Tests Valgrind
         if: matrix.config.mode == 'Debug' && matrix.config.cc == 'gcc-12'
         run: valgrind --error-exitcode=1 --show-reachable=yes --leak-check=full ./build/utl-test
+
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+      - name: Set up Python 3.13 🔧
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+      - name: Install doxygen 🔧
+        uses: ssciwr/doxygen-install@v1
+        with:
+          version: "1.13.2"
+      - name: Install Python dependencies ⚙️
+        run: pip install -r docs/requirements.txt
+      - name: Generate HTML documentation 🏗️
+        run: |
+          mkdir -p public/
+          
+      - name: Deploy documentation 🚀
+        if: github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: public/

.gitignore

@@ -2,5 +2,8 @@
 *.sublime-*
 /.idea
 /deps
+/docs/html
+/docs/xml
 /.vscode
+_build/
 .clang-tidy

CMakeLists.txt

@@ -29,3 +29,5 @@ target_link_libraries(utl-test utl gtest gmock gtest_main)
 if (NOT MSVC)
   target_compile_options(utl-test PRIVATE -Wall -Wextra -Werror)
 endif()
+
+add_subdirectory ("docs")

docs/CMakeLists.txt

@@ -0,0 +1,17 @@
+find_package(Doxygen REQUIRED)
+
+# Find all the public headers
+get_target_property(UTL_PUBLIC_HEADER_DIR utl INTERFACE_INCLUDE_DIRECTORIES)
+file(GLOB_RECURSE UTL_PUBLIC_HEADERS ${UTL_PUBLIC_HEADER_DIR}/*.h)
+
+#This will be the main output of our command
+set(DOXYGEN_INDEX_FILE ${CMAKE_CURRENT_SOURCE_DIR}/html/index.html)
+
+add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
+                   DEPENDS ${UTL_PUBLIC_HEADERS}
+                   COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
+                   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+                   MAIN_DEPENDENCY Doxyfile
+                   COMMENT "Generating docs")
+
+add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})