| 1 | site_name: vLLM |
| 2 | site_url: !ENV READTHEDOCS_CANONICAL_URL |
| 3 | repo_url: https://github.com/vllm-project/vllm |
| 4 | edit_uri: edit/main/docs/ |
| 5 | exclude_docs: | |
| 6 | *.inc.md |
| 7 | *.template.md |
| 8 | theme: |
| 9 | name: material |
| 10 | logo: assets/logos/vllm-logo-only-light.ico |
| 11 | favicon: assets/logos/vllm-logo-only-light.ico |
| 12 | palette: |
| 13 | # Palette toggle for automatic mode |
| 14 | - media: "(prefers-color-scheme)" |
| 15 | toggle: |
| 16 | icon: material/brightness-auto |
| 17 | name: Switch to light mode |
| 18 | # Palette toggle for light mode |
| 19 | - media: "(prefers-color-scheme: light)" |
| 20 | scheme: default |
| 21 | primary: white |
| 22 | toggle: |
| 23 | icon: material/brightness-7 |
| 24 | name: Switch to dark mode |
| 25 | # Palette toggle for dark mode |
| 26 | - media: "(prefers-color-scheme: dark)" |
| 27 | scheme: slate |
| 28 | primary: black |
| 29 | toggle: |
| 30 | icon: material/brightness-2 |
| 31 | name: Switch to system preference |
| 32 | features: |
| 33 | - content.action.edit |
| 34 | - content.code.copy |
| 35 | - content.tabs.link |
| 36 | - navigation.instant |
| 37 | - navigation.instant.progress |
| 38 | - navigation.tracking |
| 39 | - navigation.tabs |
| 40 | - navigation.tabs.sticky |
| 41 | - navigation.sections |
| 42 | - navigation.indexes |
| 43 | - navigation.top |
| 44 | - navigation.path |
| 45 | - search.highlight |
| 46 | - search.share |
| 47 | - toc.follow |
| 48 | custom_dir: docs/mkdocs/overrides |
| 49 | |
| 50 | hooks: |
| 51 | - docs/mkdocs/hooks/remove_announcement.py |
| 52 | - docs/mkdocs/hooks/url_schemes.py |
| 53 | - docs/mkdocs/hooks/autoref_code.py |
| 54 | |
| 55 | plugins: |
| 56 | - meta |
| 57 | - search |
| 58 | - gen-files: |
| 59 | scripts: |
| 60 | - docs/mkdocs/gen_files/generate_examples.py |
| 61 | - docs/mkdocs/gen_files/generate_argparse.py |
| 62 | - docs/mkdocs/gen_files/generate_metrics.py |
| 63 | - docs/mkdocs/gen_files/generate_attention_backends.py |
| 64 | - autorefs |
| 65 | - awesome-nav |
| 66 | - glightbox |
| 67 | - git-revision-date-localized |
| 68 | # For API reference generation |
| 69 | - api-autonav: |
| 70 | modules: ["vllm"] |
| 71 | api_root_uri: "api" |
| 72 | exclude: |
| 73 | - "re:vllm\\._.*" # Internal modules |
| 74 | - "vllm.third_party" |
| 75 | - "vllm.vllm_flash_attn" |
| 76 | - "vllm.transformers_utils.configs" |
| 77 | - "vllm.transformers_utils.processors" |
| 78 | - !ENV [API_AUTONAV_EXCLUDE, "re:^$"] # Match nothing by default |
| 79 | - mkdocstrings: |
| 80 | handlers: |
| 81 | python: |
| 82 | options: |
| 83 | filters: [] |
| 84 | show_overloads: true |
| 85 | signature_crossrefs: true |
| 86 | # Recommendations from api-autonav |
| 87 | docstring_section_style: list |
| 88 | parameter_headings: true |
| 89 | show_symbol_type_heading: true |
| 90 | show_symbol_type_toc: true |
| 91 | summary: true |
| 92 | inventories: |
| 93 | - https://docs.python.org/3/objects.inv |
| 94 | - https://numpy.org/doc/stable/objects.inv |
| 95 | - https://pytorch.org/docs/stable/objects.inv |
| 96 | - redirects: |
| 97 | redirect_maps: |
| 98 | features/spec_decode/README.md: features/speculative_decoding/README.md |
| 99 | features/spec_decode/speculators.md: features/speculative_decoding/speculators.md |
| 100 | features/quantization/fp8.md: features/quantization/llm_compressor/fp8.md |
| 101 | features/quantization/int4.md: features/quantization/llm_compressor/int4.md |
| 102 | features/quantization/int8.md: features/quantization/llm_compressor/int8_w8a8.md |
| 103 | serving/openai_compatible_server.md: serving/online_serving/README.md |
| 104 | examples/others/lmcache.md: examples/disaggregated/lmcache.md |
| 105 | |
| 106 | markdown_extensions: |
| 107 | - attr_list |
| 108 | - def_list |
| 109 | - md_in_html |
| 110 | - admonition |
| 111 | - pymdownx.details |
| 112 | # For content tabs |
| 113 | - pymdownx.superfences: |
| 114 | custom_fences: |
| 115 | - name: mermaid |
| 116 | class: mermaid |
| 117 | format: !!python/name:pymdownx.superfences.fence_code_format |
| 118 | - pymdownx.tabbed: |
| 119 | slugify: !!python/object/apply:pymdownx.slugs.slugify |
| 120 | kwds: |
| 121 | case: lower |
| 122 | alternate_style: true |
| 123 | # For code highlighting |
| 124 | - pymdownx.highlight: |
| 125 | anchor_linenums: true |
| 126 | line_spans: __span |
| 127 | pygments_lang_class: true |
| 128 | - pymdownx.inlinehilite |
| 129 | - pymdownx.snippets |
| 130 | # For emoji and icons |
| 131 | - pymdownx.emoji: |
| 132 | emoji_index: !!python/name:material.extensions.emoji.twemoji |
| 133 | emoji_generator: !!python/name:material.extensions.emoji.to_svg |
| 134 | # For in page [TOC] (not sidebar) |
| 135 | - toc: |
| 136 | permalink: true |
| 137 | # For math rendering |
| 138 | - pymdownx.arithmatex: |
| 139 | generic: true |
| 140 | |
| 141 | extra_css: |
| 142 | - mkdocs/stylesheets/extra.css |
| 143 | |
| 144 | extra_javascript: |
| 145 | - mkdocs/javascript/run_llm_widget.js |
| 146 | - mkdocs/javascript/mathjax.js |
| 147 | - https://unpkg.com/mathjax@3.2.2/es5/tex-mml-chtml.js |
| 148 | - mkdocs/javascript/edit_and_feedback.js |
| 149 | - mkdocs/javascript/slack_and_forum.js |
| 150 | - mkdocs/javascript/reo.js |