From 9949c917d43fddf521350db105e38ce7ea820246 Mon Sep 17 00:00:00 2001
From: Aidan Reilly <74046732+aireilly@users.noreply.github.com>
Date: Mon, 21 Jul 2025 09:42:27 +0100
Subject: [PATCH] Small changes for docs build

Signed-off-by: Aidan Reilly <74046732+aireilly@users.noreply.github.com>
---
 .gitignore     |  4 +---
 docs/Makefile  | 26 ++++++++++++++++++++++++++
 docs/README.md | 25 +++++++++++++++++++++++++
 3 files changed, 52 insertions(+), 3 deletions(-)
 create mode 100644 docs/Makefile
 create mode 100644 docs/README.md

diff --git a/.gitignore b/.gitignore
index ea0331b26..146c0c7bb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -93,9 +93,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-
 # PyBuilder
 target/
 
@@ -129,6 +126,7 @@ venv.bak/
 
 # mkdocs documentation
 /site
+docs/.cache/
 
 # mypy
 .mypy_cache/
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 000000000..3052e1461
--- /dev/null
+++ b/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/ 
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..bcad20e8f
--- /dev/null
+++ b/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.
\ No newline at end of file