Merge branch 'main' into feat/deferred-activation-qparams

Author: HDCharles

.claude/skills/style.md

@@ -0,0 +1,9 @@
+# Code Quality Check
+
+After completing a batch of code changes:
+
+1. Run `make style` to auto-format the code
+2. Run `make quality` to validate code quality
+3. Fix any issues reported by `make quality`
+
+When writing code, keep lines under 88 characters and avoid unnecessary indentation.

.claude/skills/test.md

@@ -0,0 +1,20 @@
+# Running Tests
+
+Nearly all tests in this project require a GPU.
+
+When running tests:
+
+1. First check if `canhazgpu` is available: `which canhazgpu`
+2. If available, MUST run tests using `canhazgpu` with appropriate GPU allocation
+3. Use the format: `canhazgpu --gpus 1 -- python3 -m pytest tests/...`
+
+Example:
+```bash
+# Check if canhazgpu is available
+which canhazgpu
+
+# Run tests with canhazgpu (required if available)
+canhazgpu --gpus 1 -- python3 -m pytest tests/test_example.py
+```
+
+Note: Adjust the `--gpus` count based on test requirements (typically 1 GPU is sufficient for most tests).

.gitignore

@@ -128,6 +128,13 @@ venv.bak/
 /site
 docs/.cache/*
 
+# zensical docs build (generated by pre-build scripts)
+docs/api/llmcompressor/
+docs/examples/
+docs/experimental/
+docs/developer/code-of-conduct.md
+docs/developer/contributing.md
+
 # mypy
 .mypy_cache/
 ### Example user template template
@@ -811,5 +818,3 @@ env_log.json
 # uv artifacts
 uv.lock
 .venv/
-
-.claude/

.readthedocs.yaml

@@ -1,22 +1,16 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
-# Set the OS, Python version, and other tools you might need
 build:
   os: ubuntu-24.04
   tools:
     python: "3.12"
-
-# Build documentation with Mkdocs
-mkdocs:
-   configuration: mkdocs.yml
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - dev
+  jobs:
+    install:
+      - pip install -e ".[dev]"
+    build:
+      html:
+        - python docs/scripts/zensical_gen_files.py
+        - zensical build
+    post_build:
+      - mkdir -p $READTHEDOCS_OUTPUT/html/
+      - cp --recursive site/* $READTHEDOCS_OUTPUT/html/

docs/.nav.yml

@@ -1,7 +1,7 @@
 nav:
   - Home: index.md
   - Why use LLM Compressor?: steps/why-llmcompressor.md
-  - Compresssing your model, step-by-step:
+  - Compressing your model, step-by-step:
     - Choosing your model: steps/choosing-model.md
     - Choosing the right compression scheme: steps/choosing-scheme.md
     - Choosing the right compression algorithm: steps/choosing-algo.md

docs/DEVELOPMENT.md

@@ -0,0 +1,43 @@
+# Getting started with LLM Compressor docs
+
+```bash
+cd docs
+```
+
+- Install the dependencies:
+
+```bash
+make install
+```
+
+- Clean the previous build (optional but recommended):
+
+```bash
+make clean
+```
+
+- Generate docs content (files, API references, and navigation):
+
+```bash
+make gen
+```
+
+- Serve the docs locally (runs `gen` automatically):
+
+```bash
+make serve
+```
+
+This will start a local server. You can now open your browser and view the documentation.
+
+- Build the static site (runs `gen` automatically):
+
+```bash
+make build
+```
+
+- List all available targets:
+
+```bash
+make help
+```

docs/Makefile

@@ -1,26 +1,32 @@
-# Minimal mkdocs makefile
+# Minimal zensical makefile
 
-PYTHON      := python3
-MKDOCS_CMD  := mkdocs
-MKDOCS_CONF := ../mkdocs.yml
+ZENSICAL_CMD := zensical
+ZENSICAL_CONF := ../zensical.toml
 
-.PHONY: help install serve build clean
+.PHONY: help install gen serve build clean
 
 help:
 	@echo "Available targets:"
 	@echo "  install  Install dependencies globally"
+	@echo "  gen      Generate docs content (files + API + nav)"
 	@echo "  serve    Serve docs locally"
 	@echo "  build    Build static site"
 	@echo "  clean    Remove build artifacts"
 
 install:
 	pip install -e "../[dev]"
 
-serve:
-	$(MKDOCS_CMD) serve --livereload -f $(MKDOCS_CONF)
+gen:
+	cd .. && python docs/scripts/zensical_gen_files.py
 
-build:
-	$(MKDOCS_CMD) build -f $(MKDOCS_CONF)
+serve: gen
+	cd .. && $(ZENSICAL_CMD) serve
+
+build: gen
+	cd .. && $(ZENSICAL_CMD) build
 
 clean:
-	rm -rf site/ .cache/ 
+	rm -rf site/ .cache/ api/llmcompressor/
+	rm -rf examples/ experimental/
+	rm -f developer/code-of-conduct.md developer/contributing.md
+	cd .. && python3 docs/scripts/zensical_gen_files.py --clean