add doxygen docs target

Author: wokron

.github/workflows/deploy-docs.yml

@@ -0,0 +1,55 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ "master" ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-26.04
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Doxygen
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y doxygen
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Configure CMake
+        run: cmake -B build -DUBLKCPP_BUILD_DOCS=ON
+
+      - name: Build Documentation
+        run: cmake --build build --target docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./build/docs/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-26.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

CMakeLists.txt

@@ -1,10 +1,21 @@
 cmake_minimum_required(VERSION 3.13)
 
-project(ublkcpp LANGUAGES CXX)
+# Version is defined once in the version header.
+set(UBLKCPP_VERSION_HEADER include/ublk/version.hpp)
+file(READ ${UBLKCPP_VERSION_HEADER} _ublkcpp_version_h)
+string(REGEX MATCH "#define UBLKCPP_VERSION_MAJOR ([0-9]+)" _ublkcpp_ver_m "${_ublkcpp_version_h}")
+set(UBLKCPP_VERSION_MAJOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "#define UBLKCPP_VERSION_MINOR ([0-9]+)" _ublkcpp_ver_m "${_ublkcpp_version_h}")
+set(UBLKCPP_VERSION_MINOR ${CMAKE_MATCH_1})
+set(UBLKCPP_VERSION_STRING "v${UBLKCPP_VERSION_MAJOR}.${UBLKCPP_VERSION_MINOR}")
+
+project(ublkcpp VERSION ${UBLKCPP_VERSION_MAJOR}.${UBLKCPP_VERSION_MINOR} LANGUAGES CXX)
+message(STATUS "Configuring ublkcpp ${UBLKCPP_VERSION_STRING}")
 
 option(UBLKCPP_BUILD_TESTS "Build tests" OFF)
 option(UBLKCPP_BUILD_UBLKCTL "Build ublkctl" OFF)
 option(UBLKCPP_BUILD_EXAMPLES "Build examples" OFF)
+option(UBLKCPP_BUILD_DOCS "Build Doxygen documentation" OFF)
 option(UBLKCPP_USE_URING_CMD128 "Use IORING_OP_URING_CMD128 for control commands" ON)
 option(UBLKCPP_TESTS_STATIC_LINK "Use static linking for tests" OFF)
 option(UBLKCPP_TESTS_ASAN "Enable address and undefined behavior sanitizers for tests" OFF)
@@ -13,6 +24,7 @@ include(FetchContent)
 
 set(DOCTEST_VERSION v2.5.0)
 set(CLI11_VERSION v2.7.2)
+set(DOXYGEN_AWESOME_CSS_VERSION v2.4.1)
 
 FetchContent_Declare(
     doctest
@@ -24,6 +36,11 @@ FetchContent_Declare(
     URL https://github.com/CLIUtils/CLI11/releases/download/${CLI11_VERSION}/CLI11.hpp
     DOWNLOAD_NO_EXTRACT TRUE
 )
+FetchContent_Declare(
+    doxygen-awesome-css
+    URL https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/${DOXYGEN_AWESOME_CSS_VERSION}/doxygen-awesome.css
+    DOWNLOAD_NO_EXTRACT TRUE
+)
 
 add_library(ublkcpp INTERFACE)
 target_include_directories(ublkcpp INTERFACE include)
@@ -51,3 +68,8 @@ if(UBLKCPP_BUILD_EXAMPLES)
     message(STATUS "Configuring examples in ${CMAKE_CURRENT_SOURCE_DIR}/examples")
     add_subdirectory(examples)
 endif()
+
+if(UBLKCPP_BUILD_DOCS)
+    message(STATUS "Configuring docs in ${CMAKE_CURRENT_SOURCE_DIR}/docs")
+    add_subdirectory(docs)
+endif()

docs/CMakeLists.txt

@@ -0,0 +1,15 @@
+find_program(DOXYGEN_EXECUTABLE NAMES doxygen REQUIRED)
+
+message(STATUS "Fetching doxygen-awesome-css")
+FetchContent_MakeAvailable(doxygen-awesome-css)
+FetchContent_GetProperties(doxygen-awesome-css SOURCE_DIR AWESOME_CSS_DIR)
+
+set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
+
+add_custom_target(docs
+    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Generate Doxygen documentation into ${CMAKE_CURRENT_BINARY_DIR}/html"
+    VERBATIM)