Skip to content

Initial implementation for the docs site and setup for LLM Compressor #1436

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

Merged
merged 3 commits into from
Jul 18, 2025

Conversation

markurtz
Copy link
Collaborator

@markurtz markurtz commented May 15, 2025

SUMMARY:

LLM Compressor docs website enablement using mkdocs. Additionally, docs structure and required pages have been populated as a starting point.

Docs are available at https://vllm-project.github.io/llm-compressor/ currently, they will be deployed to https://docs.vllm.ai/projects/ through vLLM's read the docs setup utilizing the .readthedocs.yaml file.

To run locally:

pip install -e ./[dev]
mkdocs serve

To build locally:

pip install -e ./[dev]
mkdocs build

TEST PLAN:

Manual testing

Copy link

👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review.

Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed.

@markurtz markurtz self-assigned this May 15, 2025
@markurtz markurtz merged commit 2c70cb0 into main Jul 18, 2025
10 checks passed
@markurtz markurtz deleted the docs-enablement branch July 18, 2025 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant