llm-compressor/zensical.toml at main · vllm-project/llm-compressor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
[project]
site_name = "LLM Compressor Docs"
site_description = "Documentation for LLM Compressor, an easy-to-use library for compressing large language models for deployment with vLLM."
site_url = "https://docs.vllm.ai/projects/llm-compressor/en/latest/"
repo_url = "https://github.com/vllm-project/llm-compressor"
repo_name = "vllm-project/llm-compressor"
edit_uri = "edit/main/docs/"

# nav created using build script based on ./.nav.yml
nav = []

[[project.extra_javascript]]
path = "scripts/mathjax.js"

[[project.extra_javascript]]
path = "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"

[project.extra]
generator = false

[project.theme]
variant = "classic"
language = "en"
logo = "assets/llmcompressor-icon-white.png"
favicon = "assets/llmcompressor-icon-white.png"
features = [
    "content.action.edit",
    "content.code.annotate",
    "content.code.copy",
    "content.code.select",
    "navigation.footer",
    "navigation.indexes",
    "navigation.instant",
    "navigation.path",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
    "toc.follow",
]

[project.theme.font]
text = "Roboto"
code = "Roboto Mono"

# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "material/brightness-auto"
toggle.name = "Switch to light mode"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "material/brightness-7"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "material/brightness-4"
toggle.name = "Switch to system preference"

# Markdown extensions
# Since we customize some extensions, ALL must be declared explicitly
# (Zensical replaces the full default set when any extension is configured)

# Python Markdown extensions (no options)
[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.tables]

# Python Markdown extensions (with options)
[project.markdown_extensions.toc]
toc_depth = 3

# PyMdown extensions (no options)
[project.markdown_extensions.pymdownx.betterem]
[project.markdown_extensions.pymdownx.blocks.caption]
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.magiclink]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.tilde]

# PyMdown extensions (with options)
[project.markdown_extensions.pymdownx.arithmatex]
generic = true

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
    { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true

[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

# Plugins
# Note: api-autonav, gen-files, awesome-nav, section-index are MkDocs plugins
# not yet compatible with Zensical. API docs are generated via zensical_gen_files.py
# as a pre-build step (see docs/Makefile).

[project.plugins.mkdocstrings]
default_handler = "python"

[project.plugins.mkdocstrings.handlers.python]
paths = ["src"]
load_external_modules = false

[project.plugins.mkdocstrings.handlers.python.options]
docstring_section_style = "list"
show_if_no_docstring = false
docstring_style = "sphinx"
filters = ["!docstring", "!^_"]
heading_level = 1
merge_init_into_class = true
parameter_headings = false
separate_signature = true
show_root_heading = true
show_signature_annotations = true
show_symbol_type_heading = true
show_symbol_type_toc = true
summary = true