site_name: vLLM site_url: !ENV READTHEDOCS_CANONICAL_URL repo_url: https://github.com/vllm-project/vllm edit_uri: edit/main/docs/ exclude_docs: | argparse *.inc.md *.template.md theme: name: material logo: assets/logos/vllm-logo-only-light.ico favicon: assets/logos/vllm-logo-only-light.ico palette: # Palette toggle for automatic mode - media: "(prefers-color-scheme)" toggle: icon: material/brightness-auto name: Switch to light mode # Palette toggle for light mode - media: "(prefers-color-scheme: light)" scheme: default primary: white toggle: icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: black toggle: icon: material/brightness-2 name: Switch to system preference features: - content.action.edit - content.code.copy - content.tabs.link - navigation.instant - navigation.instant.progress - navigation.tracking - navigation.tabs - navigation.tabs.sticky - navigation.sections - navigation.indexes - navigation.top - search.highlight - search.share - toc.follow custom_dir: docs/mkdocs/overrides

hooks:

docs/mkdocs/hooks/remove_announcement.py
docs/mkdocs/hooks/generate_examples.py
docs/mkdocs/hooks/generate_argparse.py
docs/mkdocs/hooks/generate_metrics.py
docs/mkdocs/hooks/url_schemes.py

plugins:

meta
search
autorefs
awesome-nav
glightbox
git-revision-date-localized:
exclude autogenerated files
exclude: - argparse/* - examples/*
minify: minify_html: true minify_js: true minify_css: true cache_safe: true js_files: [docs/mkdocs/javascript/.js] css_files: [docs/mkdocs/stylesheets/.css]

For API reference generation

api-autonav: modules: ["vllm"] api_root_uri: "api" exclude: - "re:vllm\._." # Internal modules - "vllm.third_party" - "vllm.vllm_flash_attn" - "re:vllm\.grpc\.._pb2.*" # Auto-generated protobuf files - !ENV [API_AUTONAV_EXCLUDE, "re:^$"] # Match nothing by default
mkdocstrings: handlers: python: options: show_symbol_type_heading: true show_symbol_type_toc: true filters: - "!.*_pb2_grpc" # Exclude auto-generated gRPC stubs summary: modules: true show_if_no_docstring: true show_signature_annotations: true separate_signature: true show_overloads: true signature_crossrefs: true inventories: - https://docs.python.org/3/objects.inv - https://typing-extensions.readthedocs.io/en/latest/objects.inv - https://docs.aiohttp.org/en/stable/objects.inv - https://pillow.readthedocs.io/en/stable/objects.inv - https://numpy.org/doc/stable/objects.inv - https://pytorch.org/docs/stable/objects.inv - https://psutil.readthedocs.io/en/stable/objects.inv

markdown_extensions:

attr_list
def_list
md_in_html
admonition
pymdownx.details

For content tabs

pymdownx.superfences
pymdownx.tabbed: slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower alternate_style: true

For code highlighting

pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true
pymdownx.inlinehilite
pymdownx.snippets

For emoji and icons

pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg

For in page [TOC] (not sidebar)

toc: permalink: true

For math rendering

pymdownx.arithmatex: generic: true

extra_css:

mkdocs/stylesheets/extra.css

extra_javascript:

mkdocs/javascript/reo.js
mkdocs/javascript/run_llm_widget.js
mkdocs/javascript/mathjax.js
https://unpkg.com/[email protected]/es5/tex-mml-chtml.js
mkdocs/javascript/edit_and_feedback.js
mkdocs/javascript/slack_and_forum.js

For API reference generation

api-autonav: modules: ["vllm"] api_root_uri: "api" exclude: - "re:vllm\._." # Internal modules - "vllm.third_party" - "vllm.vllm_flash_attn" - "re:vllm\.grpc\.._pb2.*" # Auto-generated protobuf files - !ENV [API_AUTONAV_EXCLUDE, "re:^$"] # Match nothing by default

mkdocstrings: handlers: python: options: show_symbol_type_heading: true show_symbol_type_toc: true filters: - "!.*_pb2_grpc" # Exclude auto-generated gRPC stubs summary: modules: true show_if_no_docstring: true show_signature_annotations: true separate_signature: true show_overloads: true signature_crossrefs: true inventories: - https://docs.python.org/3/objects.inv - https://typing-extensions.readthedocs.io/en/latest/objects.inv - https://docs.aiohttp.org/en/stable/objects.inv - https://pillow.readthedocs.io/en/stable/objects.inv - https://numpy.org/doc/stable/objects.inv - https://pytorch.org/docs/stable/objects.inv - https://psutil.readthedocs.io/en/stable/objects.inv

markdown_extensions:

attr_list

def_list

md_in_html

admonition

pymdownx.details

For math rendering

pymdownx.arithmatex: generic: true

extra_css:

mkdocs/stylesheets/extra.css

extra_javascript:

mkdocs/javascript/reo.js

mkdocs/javascript/run_llm_widget.js

mkdocs/javascript/mathjax.js

https://unpkg.com/[email protected]/es5/tex-mml-chtml.js

mkdocs/javascript/edit_and_feedback.js

mkdocs/javascript/slack_and_forum.js

site_name: vLLM

exclude autogenerated files

For API reference generation

For content tabs

For code highlighting

For emoji and icons

For in page [TOC] (not sidebar)

For math rendering

Related Skills

<h1 align="center">

2. Apply Deepthink Protocol (reason about dependencies

- Identify gaps

exclude autogenerated files

For API reference generation

For content tabs

For code highlighting

For emoji and icons

For in page [TOC] (not sidebar)

For math rendering