vllm
Add full API docs and improve the UX of navigating them
#17485
Merged
Overview
Commits
64
Changes
View On GitHub

Add full API docs and improve the UX of navigating them #17485

vllm-bot merged 64 commits into vllm-project:main from hmellor:add-config-docs
hmellor
hmellor Add config page to index
01097319
hmellor Configure `autodoc2`
61d0b076
hmellor Add `config.md`
3eaf9269
github-actions
hmellor hmellor changed the title Add-config-docs Add config classes to API docs 1 year ago
mergify mergify added documentation
hmellor Add missing requirement
9e5fad87
mergify mergify added ci/build
DarkLight1337
DarkLight1337 commented on 2025-04-30
hmellor Typo
57f40c53
hmellor Replace links for offline
ef6a592d
aarnphm aarnphm requested a review from DarkLight1337 DarkLight1337 1 year ago
hmellor
hmellor Generate full API docs
7964a17b
hmellor Replace tiny API ref files with one index of all important stuff
a16ebb0a
hmellor Fix some links
3283441f
hmellor Fix some sphinx errors
ede54dc4
hmellor Remove old `autodoc` and `autosummary`
c2d2cdb8
hmellor `linkcode_resolve` without importing vllm
7974d657
hmellor Improve navigation of API docs
e4730103
hmellor Don't include undocumented or private objects
cb5c57c7
hmellor Exclude auto generated files we don't use
e4dd76fe
hmellor hmellor requested a review from WoosukKwon WoosukKwon 1 year ago
hmellor hmellor requested a review from robertgshaw2-redhat robertgshaw2-redhat 1 year ago
hmellor hmellor requested a review from njhill njhill 1 year ago
hmellor hmellor requested a review from ywang96 ywang96 1 year ago
hmellor hmellor requested a review from comaniac comaniac 1 year ago
hmellor hmellor requested a review from alexm-redhat alexm-redhat 1 year ago
hmellor hmellor changed the title Add config classes to API docs Add full API docs and improve the UX of navigating them 1 year ago
mergify mergify added frontend
mergify mergify added v1
hmellor Make pre-commit happy
6a5470b4
hmellor Fix PR linkcode?
583dc4e0
hmellor Fix pre-commit one last time
22c3627b
DarkLight1337
DarkLight1337 commented on 2025-05-01
hmellor Review comment
8eaaf377
hmellor `VLLM_ROOT` is the `pr_number` dir?
7758013f
hmellor `index.md` -> `summary.md`
5c2bb25c
hmellor rst -> myst (:x:`y` -> {x}`y`)
c867efc3
hmellor hmellor requested a review from zhuohan123 zhuohan123 1 year ago
hmellor hmellor requested a review from youkaichao youkaichao 1 year ago
mergify
mergify mergify added multi-modality
mergify mergify added needs-rebase
hmellor Merge branch 'main' into add-config-docs
f6e40766
mergify mergify removed needs-rebase
hmellor 3 erroneous find and replaces
5cdd7427
hmellor Fix `.. code-block`s
e6264a29
hmellor Support autodoc with indented attrs
6b0d53c2
hmellor Fix Google style docstrings
93844544
hmellor Fix doc build errors
43cf0f6a
mergify mergify added speculative-decoding
hmellor pre-commit
f622e00e
hmellor Update API ref that gets checked
231931ea
hmellor
hmellor commented on 2025-05-02
mergify
mergify mergify added needs-rebase
hmellor Merge branch 'main' into add-config-docs
2125869d
hmellor Fix indentation in regex
5e33bb54
mergify mergify removed needs-rebase
hmellor Add vllm._C mock
0af3785c
mergify
mergify mergify added needs-rebase
hmellor Fix whitespace errpr
0a0d3c46
hmellor Merge branch 'main' into add-config-docs
811937d1
mergify mergify removed needs-rebase
hmellor Fix linkcode_resolve for class members
5a4dbc81
hmellor Update admonitions in LLM docstrings
885a7844
hmellor Convert math and admonitions
4eb9f436
hmellor Remove whitespace
ca4c36e2
hmellor Fix line number detection final
c6d8a5ff
hmellor Replace `See also:`
743c0ce1
hmellor Find all public interfaces
6821ff6c
hmellor fix
1388ec17
mergify
mergify mergify added needs-rebase
hmellor Add skip for bad `__init__` files
4ad4e3cd
hmellor Fix some Sphinx warnings
0ec355ef
hmellor Remove warning
b1857d73
hmellor Merge branch 'main' into add-config-docs
92f738c2
mergify mergify removed needs-rebase
hmellor pre-commit
0dfe026b
hmellor pre-commit
5bbc79bf
hmellor Revert change to platforms/__init__.py (we're not documenting that yet)
144d4e40
DarkLight1337
hmellor
hmellor Don't ignore any generated API docs
58933587
hmellor Auto document the full API, not just `__all__`
a6d559ea
hmellor Sort alphabetically for ease of navigation
c86c2f37
hmellor Improve `AsyncLLM` docstring
c912d93c
hmellor Improve `LLMEngine` docstirng
09191c63
hmellor Don't skip undocumented objects
4bec5367
hmellor Use code block for ASCII diagram
aa8102bb
hmellor Dis ambiguous references in docstrings
56bc677d
hmellor Remove unnecessary newline
61bf9dad
hmellor pre-commit
09490fda
hmellor Make build leaner
f8f34748
DarkLight1337
DarkLight1337 approved these changes on 2025-05-03
DarkLight1337
DarkLight1337 DarkLight1337 added ready
hmellor Fix buildkite docs build test
bda4378f
hmellor Merge branch 'main' into add-config-docs
7df399f3
hmellor Fix import error in example
a0d7039e
vllm-bot vllm-bot merged d6484ef3 into main 1 year ago
hmellor hmellor deleted the add-config-docs branch 1 year ago

Login to write a write a comment.

Login via GitHub

Reviewers
Assignees
No one assigned
Labels
documentation frontend speculative-decoding ready ci/build v1 multi-modality
Milestone
No milestone
Terms Of Use Privacy Policy Refund Policy Impressum