Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
0109731
Add config page to index
hmellor Apr 30, 2025
61d0b07
Configure `autodoc2`
hmellor Apr 30, 2025
3eaf926
Add `config.md`
hmellor Apr 30, 2025
9e5fad8
Add missing requirement
hmellor Apr 30, 2025
57f40c5
Typo
hmellor Apr 30, 2025
ef6a592
Replace links for offline
hmellor Apr 30, 2025
7964a17
Generate full API docs
hmellor May 1, 2025
a16ebb0
Replace tiny API ref files with one index of all important stuff
hmellor May 1, 2025
3283441
Fix some links
hmellor May 1, 2025
ede54dc
Fix some sphinx errors
hmellor May 1, 2025
c2d2cdb
Remove old `autodoc` and `autosummary`
hmellor May 1, 2025
7974d65
`linkcode_resolve` without importing vllm
hmellor May 1, 2025
e473010
Improve navigation of API docs
hmellor May 1, 2025
cb5c57c
Don't include undocumented or private objects
hmellor May 1, 2025
e4dd76f
Exclude auto generated files we don't use
hmellor May 1, 2025
6a5470b
Make pre-commit happy
hmellor May 1, 2025
583dc4e
Fix PR linkcode?
hmellor May 1, 2025
22c3627
Fix pre-commit one last time
hmellor May 1, 2025
8eaaf37
Review comment
hmellor May 1, 2025
7758013
`VLLM_ROOT` is the `pr_number` dir?
hmellor May 1, 2025
5c2bb25
`index.md` -> `summary.md`
hmellor May 1, 2025
c867efc
rst -> myst (:x:`y` -> {x}`y`)
hmellor May 1, 2025
f6e4076
Merge branch 'main' into add-config-docs
hmellor May 1, 2025
5cdd742
3 erroneous find and replaces
hmellor May 1, 2025
e6264a2
Fix `.. code-block`s
hmellor May 1, 2025
6b0d53c
Support autodoc with indented attrs
hmellor May 1, 2025
9384454
Fix Google style docstrings
hmellor May 1, 2025
43cf0f6
Fix doc build errors
hmellor May 1, 2025
f622e00
pre-commit
hmellor May 1, 2025
231931e
Update API ref that gets checked
hmellor May 2, 2025
2125869
Merge branch 'main' into add-config-docs
hmellor May 2, 2025
5e33bb5
Fix indentation in regex
hmellor May 2, 2025
0af3785
Add vllm._C mock
hmellor May 2, 2025
0a0d3c4
Fix whitespace errpr
hmellor May 2, 2025
811937d
Merge branch 'main' into add-config-docs
hmellor May 2, 2025
5a4dbc8
Fix linkcode_resolve for class members
hmellor May 2, 2025
885a784
Update admonitions in LLM docstrings
hmellor May 2, 2025
4eb9f43
Convert math and admonitions
hmellor May 2, 2025
ca4c36e
Remove whitespace
hmellor May 2, 2025
c6d8a5f
Fix line number detection final
hmellor May 2, 2025
743c0ce
Replace `See also:`
hmellor May 2, 2025
6821ff6
Find all public interfaces
hmellor May 2, 2025
1388ec1
fix
hmellor May 2, 2025
4ad4e3c
Add skip for bad `__init__` files
hmellor May 2, 2025
0ec355e
Fix some Sphinx warnings
hmellor May 2, 2025
b1857d7
Remove warning
hmellor May 2, 2025
92f738c
Merge branch 'main' into add-config-docs
hmellor May 2, 2025
0dfe026
pre-commit
hmellor May 2, 2025
5bbc79b
pre-commit
hmellor May 2, 2025
144d4e4
Revert change to platforms/__init__.py (we're not documenting that yet)
hmellor May 2, 2025
5893358
Don't ignore any generated API docs
hmellor May 3, 2025
a6d559e
Auto document the full API, not just `__all__`
hmellor May 3, 2025
c86c2f3
Sort alphabetically for ease of navigation
hmellor May 3, 2025
c912d93
Improve `AsyncLLM` docstring
hmellor May 3, 2025
09191c6
Improve `LLMEngine` docstirng
hmellor May 3, 2025
4bec536
Don't skip undocumented objects
hmellor May 3, 2025
aa8102b
Use code block for ASCII diagram
hmellor May 3, 2025
56bc677
Dis ambiguous references in docstrings
hmellor May 3, 2025
61bf9da
Remove unnecessary newline
hmellor May 3, 2025
09490fd
pre-commit
hmellor May 3, 2025
f8f3474
Make build leaner
hmellor May 3, 2025
bda4378
Fix buildkite docs build test
hmellor May 3, 2025
7df399f
Merge branch 'main' into add-config-docs
hmellor May 3, 2025
a0d7039
Fix import error in example
hmellor May 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .buildkite/test-pipeline.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ steps:
- pip install -r ../../requirements/docs.txt
- SPHINXOPTS=\"-W\" make html
# Check API reference (if it fails, you may have missing mock imports)
- grep \"sig sig-object py\" build/html/api/inference_params.html
- grep \"sig sig-object py\" build/html/api/vllm/vllm.sampling_params.html

- label: Async Engine, Inputs, Utils, Worker Test # 24min
source_file_dependencies:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ instance/
# Sphinx documentation
docs/_build/
docs/source/getting_started/examples/
docs/source/api/vllm

# PyBuilder
.pybuilder/
Expand Down
1 change: 1 addition & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ help:
clean:
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
rm -rf "$(SOURCEDIR)/getting_started/examples"
rm -rf "$(SOURCEDIR)/api/vllm"
7 changes: 0 additions & 7 deletions docs/source/api/engine/async_llm_engine.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/source/api/engine/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/api/engine/llm_engine.md

This file was deleted.

21 changes: 0 additions & 21 deletions docs/source/api/inference_params.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/model/adapters.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/source/api/model/index.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/model/interfaces.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/model/interfaces_base.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/source/api/multimodal/index.md

This file was deleted.

49 changes: 0 additions & 49 deletions docs/source/api/multimodal/inputs.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/multimodal/parse.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/multimodal/processing.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/multimodal/profiling.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/multimodal/registry.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/source/api/offline_inference/index.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/api/offline_inference/llm.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/source/api/offline_inference/llm_inputs.md

This file was deleted.

Loading