refactor: move docs commands to Makefile for consistency

Author: nullccxsy

.github/workflows/docs.yml

@@ -31,23 +31,15 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install mkdocs-material
           sudo apt-get update
           sudo apt-get install -y doxygen
+          make install-deps
 
       - name: Build API documentation with Doxygen
-        run: |
-          cd mkdocs
-          mkdir -p docs/api
-          doxygen Doxyfile
-          echo "Doxygen output created in docs/api/"
+        run: make build-api-docs
 
       - name: Build docs
-        run: |
-          cd mkdocs
-          mkdocs build --clean
-          echo "MkDocs site built in site/"
+        run: make build-docs
 
       - name: Deploy to gh-pages
         if: github.event_name == 'pull_request'

Makefile

@@ -0,0 +1,34 @@
+.PHONY: help install-deps build-api-docs build-docs clean-docs serve-docs
+
+help:
+	@echo "Available targets:"
+	@echo "  install-deps     - Install Python dependencies"
+	@echo "  build-api-docs   - Build API documentation with Doxygen"
+	@echo "  build-docs       - Build MkDocs documentation"
+	@echo "  clean-docs       - Clean documentation build artifacts"
+	@echo "  serve-docs       - Serve documentation locally for development"
+	@echo "  all              - Build all documentation"
+
+install-deps:
+	python -m pip install --upgrade pip
+	pip install -r requirements.txt
+
+build-api-docs:
+	cd mkdocs && \
+	mkdir -p docs/api && \
+	doxygen Doxyfile && \
+	echo "Doxygen output created in docs/api/"
+
+build-docs:
+	cd mkdocs && \
+	mkdocs build --clean && \
+	echo "MkDocs site built in site/"
+
+clean-docs:
+	rm -rf mkdocs/site
+	rm -rf mkdocs/docs/api
+
+serve-docs:
+	cd mkdocs && mkdocs serve
+
+all: build-api-docs build-docs

mkdocs/docs/index.md

@@ -117,16 +117,6 @@ Run specific test:
 ctest --test-dir build -R test_name
 ```
 
-#### Test Coverage
-
-We aim for high test coverage. Run tests with coverage:
-
-```bash
-cmake -S . -B build -DICEBERG_BUILD_COVERAGE=ON
-cmake --build build
-ctest --test-dir build
-```
-
 ### Linting
 
 Install the python package `pre-commit` and run once `pre-commit install`:

requirements.txt

@@ -0,0 +1 @@
+mkdocs-material>=9.4.0,<10.0.0