From 34128a697ed2dd4d88a9829f35445fbfc5b85c64 Mon Sep 17 00:00:00 2001 From: Harry Mellor <19981378+hmellor@users.noreply.github.com> Date: Tue, 23 Apr 2024 02:53:01 +0100 Subject: [PATCH] Fix `autodoc` directives (#4272) Co-authored-by: Harry Mellor --- docs/source/dev/engine/async_llm_engine.rst | 5 ++--- docs/source/dev/engine/llm_engine.rst | 6 +++--- docs/source/dev/sampling_params.rst | 3 ++- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/dev/engine/async_llm_engine.rst b/docs/source/dev/engine/async_llm_engine.rst index 47db1e0a401b..93fc310cb543 100644 --- a/docs/source/dev/engine/async_llm_engine.rst +++ b/docs/source/dev/engine/async_llm_engine.rst @@ -1,7 +1,6 @@ - AsyncLLMEngine ================================= -.. autoclass:: vllm.engine.async_llm_engine.AsyncLLMEngine - :members: generate, abort +.. autoclass:: vllm.AsyncLLMEngine + :members: :show-inheritance: diff --git a/docs/source/dev/engine/llm_engine.rst b/docs/source/dev/engine/llm_engine.rst index 1de6d7adc87c..0b8c1e219d7c 100644 --- a/docs/source/dev/engine/llm_engine.rst +++ b/docs/source/dev/engine/llm_engine.rst @@ -1,6 +1,6 @@ LLMEngine ================================= -.. autoclass:: vllm.engine.llm_engine.LLMEngine - :members: add_request, abort_request, step - :show-inheritance: \ No newline at end of file +.. autoclass:: vllm.LLMEngine + :members: + :show-inheritance: diff --git a/docs/source/dev/sampling_params.rst b/docs/source/dev/sampling_params.rst index 844859b3ec1f..ef3d1509bda6 100644 --- a/docs/source/dev/sampling_params.rst +++ b/docs/source/dev/sampling_params.rst @@ -1,4 +1,5 @@ Sampling Params =============== -.. automodule:: vllm.sampling_params.SamplingParams \ No newline at end of file +.. autoclass:: vllm.SamplingParams + :members: