Small changes for docs build

Author: aireilly

.gitignore

@@ -93,9 +93,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-
 # PyBuilder
 target/
 
@@ -129,6 +126,7 @@ venv.bak/
 
 # mkdocs documentation
 /site
+.cache/
 
 # mypy
 .mypy_cache/
@@ -806,3 +804,4 @@ wandb/
 timings/
 output_finetune/
 env_log.json
+docs/.cache/

docs/Makefile

@@ -0,0 +1,26 @@
+# Minimal mkdocs makefile
+
+PYTHON      := python3
+MKDOCS_CMD  := mkdocs
+MKDOCS_CONF := ../mkdocs.yml
+
+.PHONY: help install serve build clean
+
+help:
+	@echo "Available targets:"
+	@echo "  install  Install dependencies globally"
+	@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)
+
+build:
+	$(MKDOCS_CMD) build -f $(MKDOCS_CONF)
+
+clean:
+	rm -rf site/ .cache/ 

docs/README.md

@@ -0,0 +1,25 @@
+# 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
+```
+
+- Serve the docs:
+
+```bash
+make serve
+```
+
+This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.