Skip to content

[Docs] Clean up docs build #1660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,6 @@ instance/
# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

Expand Down Expand Up @@ -129,6 +126,7 @@ venv.bak/

# mkdocs documentation
/site
docs/.cache/

# mypy
.mypy_cache/
Expand Down
26 changes: 26 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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/
25 changes: 25 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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.