File tree Expand file tree Collapse file tree 3 files changed +53
-3
lines changed Expand file tree Collapse file tree 3 files changed +53
-3
lines changed Original file line number Diff line number Diff line change @@ -93,9 +93,6 @@ instance/
93
93
# Scrapy stuff:
94
94
.scrapy
95
95
96
- # Sphinx documentation
97
- docs /_build /
98
-
99
96
# PyBuilder
100
97
target /
101
98
@@ -129,6 +126,7 @@ venv.bak/
129
126
130
127
# mkdocs documentation
131
128
/site
129
+ .cache /
132
130
133
131
# mypy
134
132
.mypy_cache /
@@ -806,3 +804,4 @@ wandb/
806
804
timings /
807
805
output_finetune /
808
806
env_log.json
807
+ docs /.cache /
Original file line number Diff line number Diff line change
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/
Original file line number Diff line number Diff line change
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.
You can’t perform that action at this time.
0 commit comments