From 5d762d035fa8936efc3f7cafeab558b79d4ad1a7 Mon Sep 17 00:00:00 2001 From: DarkLight1337 Date: Mon, 26 May 2025 12:36:15 +0000 Subject: [PATCH 1/2] [Doc] Improve API docs Signed-off-by: DarkLight1337 --- docs/.nav.yml | 5 +++-- docs/mkdocs/stylesheets/extra.css | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/.nav.yml b/docs/.nav.yml index 100841aecf61..4b87655c94d3 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -54,8 +54,9 @@ nav: - V1: design/v1 - API Reference: - api/README.md - - glob: api/vllm/* - preserve_directory_names: true + - Contents: + - glob: api/vllm/* + preserve_directory_names: true - Community: - community/* - Blog: https://blog.vllm.ai diff --git a/docs/mkdocs/stylesheets/extra.css b/docs/mkdocs/stylesheets/extra.css index 165f53efc085..dd7b3460a319 100644 --- a/docs/mkdocs/stylesheets/extra.css +++ b/docs/mkdocs/stylesheets/extra.css @@ -5,7 +5,7 @@ } /* https://christianoliff.com/blog/styling-external-links-with-an-icon-in-css/ */ -a:not(:has(svg)):not(.md-icon) { +a:not(:has(svg)):not(.md-icon):not(.autorefs-external) { align-items: center; &[href^="//"]::after, From b4503410ef4c5d8664be1332dea53d9c49231d6e Mon Sep 17 00:00:00 2001 From: DarkLight1337 Date: Mon, 26 May 2025 14:33:06 +0000 Subject: [PATCH 2/2] Rename the root page of each section Signed-off-by: DarkLight1337 --- docs/.nav.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/.nav.yml b/docs/.nav.yml index 4b87655c94d3..4a870b40ed23 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -18,7 +18,7 @@ nav: - Roadmap: https://roadmap.vllm.ai - Releases: https://github.com/vllm-project/vllm/releases - User Guide: - - usage/README.md + - Summary: usage/README.md - General: - usage/* - Inference and Serving: @@ -44,7 +44,7 @@ nav: - features/* - features/quantization - Developer Guide: - - contributing/README.md + - Summary: contributing/README.md - General: - glob: contributing/* flatten_single_child_sections: true @@ -53,7 +53,7 @@ nav: - V0: design - V1: design/v1 - API Reference: - - api/README.md + - Summary: api/README.md - Contents: - glob: api/vllm/* preserve_directory_names: true