Skip to content

Commit e43b78f

Browse files
committed
Add enablement for readthedocs integration with vLLM
1 parent cefd83d commit e43b78f

File tree

3 files changed

+25
-9
lines changed

3 files changed

+25
-9
lines changed

.readthedocs.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
3+
# Read the Docs configuration file
4+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
5+
6+
# Required
7+
version: 2
8+
9+
# Set the OS, Python version, and other tools you might need
10+
build:
11+
os: ubuntu-24.04
12+
tools:
13+
python: "3.12"
14+
15+
# Build documentation with Mkdocs
16+
mkdocs:
17+
configuration: mkdocs.yml
18+
19+
python:
20+
install:
21+
- method: pip
22+
path: .
23+
extra_requirements:
24+
- dev

mkdocs.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: LLM Compressor Docs
22
site_description: Documentation for LLM Compressor, an easy-to-use library for compressing large language models for deployment with vLLM.
3-
site_url: https://vllm-project.github.io/llm-compressor
3+
site_url: https://docs.vllm.ai/projects/llm-compressor
44
repo_url: https://github.com/vllm-project/llm-compressor
55
edit_uri: https://github.com/vllm-project/llm-compressor/tree/main/docs
66

@@ -88,7 +88,6 @@ plugins:
8888
- gen-files:
8989
scripts:
9090
- docs/scripts/gen_files.py
91-
- mike
9291
- minify:
9392
minify_html: true
9493
- mkdocs-nav-weight
@@ -105,12 +104,6 @@ plugins:
105104

106105
extra:
107106
generator: false
108-
version:
109-
provider: mike
110-
alias: true
111-
default:
112-
- stable
113-
- development
114107

115108
extra_css:
116109
- stylesheets/style.css

setup.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,6 @@ def localversion_func(version: ScmVersion) -> str:
158158
# docs
159159
"mkdocs",
160160
"mkdocs-material[imaging]",
161-
"mike",
162161
"markdown",
163162
"pymdown-extensions",
164163
"mkdocs-section-index",

0 commit comments

Comments
 (0)