[Build] Use CMAKE_ARGS to control optional features (#24)

* Use cmake args and update doc

* Format with ruff

* Remove optional deps in workflow

* Run optinal only in cibuild

* Fix tests in cibuild

Author: haochengxia

.github/workflows/build.yml

@@ -43,13 +43,13 @@ jobs:
       - name: Build and test with uv
         run: |
           uv venv --python ${{ matrix.python-version }}
-          CMAKE_ARGS="-DENABLE_GLCACHE=OFF -DENABLE_LRB=OFF -DENABLE_3L_CACHE=OFF" uv pip install -e .[dev] -vvv
+          uv pip install -e .[dev] -vvv
           uv run python -c "import libcachesim; print('✓ Import successful for Python ${{ matrix.python-version }} on ${{ matrix.os }}')"
 
       - name: Run tests
         run: |
           if [ -d "tests" ]; then
-            uv run python -m pytest tests/ -v
+            uv run python -m pytest tests/ -v -m "not optional"
           else
             echo "No tests directory found, skipping tests"
           fi

CMakeLists.txt

@@ -12,9 +12,9 @@ endif()
 message(STATUS "CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
 
 # Options
-option(ENABLE_GLCACHE "Enable group-learned cache" ON)
-option(ENABLE_LRB "Enable LRB" ON)
-option(ENABLE_3L_CACHE "Enable 3LCache" ON)
+option(ENABLE_GLCACHE "Enable group-learned cache" OFF)
+option(ENABLE_LRB "Enable LRB" OFF)
+option(ENABLE_3L_CACHE "Enable 3LCache" OFF)
 
 # C++ standard
 set(CMAKE_CXX_STANDARD 17)

docs/mkdocs.yml

@@ -9,17 +9,24 @@ docs_dir: src
 nav:
   - Home: 
     - libCacheSim Python: index.md
-  - Getting Started:
-    - Quick Start: quickstart.md
+    - Getting Started: 
+      - getting_started/quickstart.md
+      - getting_started/installation.md
+    - Examples: 
+      - examples/simulation.md
+      - examples/analysis.md
+      - examples/plugins.md
+  - User Guide:
+    - FAQ: faq.md
+  - Developer Guide:
+    - General: developer.md
   - API Reference:
     - API Documentation: api.md
-  - Examples:
-    - Usage Examples: examples.md
 
 theme:
   name: material
-  logo: assets/logos/logo-only-light.ico
-  favicon: assets/logos/logo-only-light.ico
+  # logo: assets/logos/logo-only-light.ico
+  # favicon: assets/logos/logo-only-light.ico
   language: en
   palette:
     # Palette toggle for automatic mode
@@ -77,7 +84,9 @@ plugins:
           build: true
           nav_translations:
             Home: 首页
-            Quick Start: 快速开始
+            Getting Started: 快速开始
+            User Guide: 用户指南
+            Developer Guide: 开发者指南
             API Reference: API参考
             Examples: 使用示例