Skip to content

Commit 99749e6

Browse files
committed
Small changes for docs build
1 parent 2c70cb0 commit 99749e6

File tree

3 files changed

+53
-3
lines changed

3 files changed

+53
-3
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,6 @@ instance/
9393
# Scrapy stuff:
9494
.scrapy
9595

96-
# Sphinx documentation
97-
docs/_build/
98-
9996
# PyBuilder
10097
target/
10198

@@ -129,6 +126,7 @@ venv.bak/
129126

130127
# mkdocs documentation
131128
/site
129+
.cache/
132130

133131
# mypy
134132
.mypy_cache/
@@ -806,3 +804,4 @@ wandb/
806804
timings/
807805
output_finetune/
808806
env_log.json
807+
docs/.cache/

docs/Makefile

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Minimal mkdocs makefile
2+
3+
PYTHON := python3
4+
MKDOCS_CMD := mkdocs
5+
MKDOCS_CONF := ../mkdocs.yml
6+
7+
.PHONY: help install serve build clean
8+
9+
help:
10+
@echo "Available targets:"
11+
@echo " install Install dependencies globally"
12+
@echo " serve Serve docs locally"
13+
@echo " build Build static site"
14+
@echo " clean Remove build artifacts"
15+
16+
install:
17+
pip install -e "../[dev]"
18+
19+
serve:
20+
$(MKDOCS_CMD) serve --livereload -f $(MKDOCS_CONF)
21+
22+
build:
23+
$(MKDOCS_CMD) build -f $(MKDOCS_CONF)
24+
25+
clean:
26+
rm -rf site/ .cache/

docs/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Getting started with LLM Compressor docs
2+
3+
```bash
4+
cd docs
5+
```
6+
7+
- Install the dependencies:
8+
9+
```bash
10+
make install
11+
```
12+
13+
- Clean the previous build (optional but recommended):
14+
15+
```bash
16+
make clean
17+
```
18+
19+
- Serve the docs:
20+
21+
```bash
22+
make serve
23+
```
24+
25+
This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.

0 commit comments

Comments
 (0)