refactor: migrate to modules and support module-based document generation (#1)

* refactor: migrate to modules and support module-based document generation

* fix: invalid module units

* fix: scan-deps and stop-scache

* refactor: move module doc into module folder as index.md

* typo: remove common subfix of module name

* ci: fasten build process

* fix: resolve entry path in lookup function and add test for relative file resolution

Author: tsurumi-yizhou

.github/workflows/generate-docs.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   generate:
-    runs-on: windows-2025
+    runs-on: windows-latest
     permissions:
       contents: write
 
@@ -32,8 +32,41 @@ jobs:
           restore-keys: |
             Windows-sccache-
 
+      - name: Restore configure artifacts cache
+        id: restore-configure-cache
+        uses: actions/cache/restore@v5
+        with:
+          path: |
+            build/RelWithDebInfo/.llvm
+            build/RelWithDebInfo/include
+            build/RelWithDebInfo/_deps
+            build/RelWithDebInfo/*.tar.*
+          key: >-
+            Windows-configure-RelWithDebInfo-${{
+            hashFiles('pixi.lock', 'pixi.toml', '**/CMakeLists.txt', 'cmake/**/*.cmake')
+            }}-${{ github.sha }}
+          restore-keys: |
+            Windows-configure-RelWithDebInfo-${{ hashFiles('pixi.lock', 'pixi.toml', '**/CMakeLists.txt', 'cmake/**/*.cmake') }}-
+
+      - name: Start sccache
+        run: sccache --start-server
+
+      - name: Configure
+        run: pixi run cmake-config
+
+      - name: Save configure artifacts cache
+        if: success()
+        uses: actions/cache/save@v5
+        with:
+          path: |
+            build/RelWithDebInfo/.llvm
+            build/RelWithDebInfo/include
+            build/RelWithDebInfo/_deps
+            build/RelWithDebInfo/*.tar.*
+          key: ${{ steps.restore-configure-cache.outputs.cache-primary-key }}
+
       - name: Build
-        run: pixi run build
+        run: pixi run cmake-build
 
       - name: Generate documentation
         run: |
@@ -53,7 +86,3 @@ jobs:
           name: clore-docs
           path: clore-docs.zip
           retention-days: 30
-
-      - name: Stop sccache
-        if: always()
-        run: pixi run -- sccache --stop-server 2>$null

CMakeLists.txt

@@ -43,9 +43,7 @@ endif()
 set(CLORE_ENABLE_IPO OFF)
 set(CLORE_USE_LTO_ARTIFACT OFF)
 if(CLORE_ENABLE_LTO)
-    if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-        message(STATUS "Interprocedural optimization disabled for Debug builds.")
-    else()
+    if(CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
         check_ipo_supported(RESULT CLORE_IPO_SUPPORTED OUTPUT CLORE_IPO_ERROR LANGUAGES C CXX)
         if(CLORE_IPO_SUPPORTED)
             set(CLORE_ENABLE_IPO ON)
@@ -54,6 +52,8 @@ if(CLORE_ENABLE_LTO)
         else()
             message(WARNING "LTO requested but IPO is not supported by the active toolchain: ${CLORE_IPO_ERROR}")
         endif()
+    else()
+        message(STATUS "Interprocedural optimization disabled for non-RelWithDebInfo builds.")
     endif()
 endif()
 

cmake/toolchain.cmake

@@ -3,6 +3,13 @@ cmake_minimum_required(VERSION 3.30)
 set(CMAKE_C_COMPILER clang CACHE STRING "")
 set(CMAKE_CXX_COMPILER clang++ CACHE STRING "")
 
+find_program(CLANG_SCAN_DEPS_PATH NAMES "clang-scan-deps" NO_CACHE)
+if(CLANG_SCAN_DEPS_PATH)
+    set(CMAKE_CXX_COMPILER_CLANG_SCAN_DEPS "${CLANG_SCAN_DEPS_PATH}" CACHE FILEPATH "")
+else()
+    unset(CMAKE_CXX_COMPILER_CLANG_SCAN_DEPS CACHE)
+endif()
+
 find_program(LLVM_AR_PATH "llvm-ar")
 if(LLVM_AR_PATH)
     set(CMAKE_AR "${LLVM_AR_PATH}" CACHE FILEPATH "")