diff --git a/docs/.nav.yml b/docs/.nav.yml index ad742be3d6947..77342e2674d57 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -58,10 +58,9 @@ nav: - CI: contributing/ci - Design Documents: design - API Reference: - - Summary: api/README.md + - Summary: api/summary.md - Contents: - - glob: api/vllm/* - preserve_directory_names: true + - api/vllm/* - CLI Reference: - Summary: cli/README.md - Community: diff --git a/docs/api/README.md b/docs/api/summary.md similarity index 100% rename from docs/api/README.md rename to docs/api/summary.md diff --git a/docs/features/quantization/inc.md b/docs/features/quantization/inc.md index d97a462f54320..13b151bc7f380 100644 --- a/docs/features/quantization/inc.md +++ b/docs/features/quantization/inc.md @@ -1,7 +1,4 @@ ---- -title: FP8 INC ---- -[](){ #inc } +# FP8 INC vLLM supports FP8 (8-bit floating point) weight and activation quantization using Intel® Neural Compressor (INC) on Intel® Gaudi® 2 and Intel® Gaudi® 3 AI accelerators. Currently, quantization is validated only in Llama models. diff --git a/docs/mkdocs/hooks/generate_examples.py b/docs/mkdocs/hooks/generate_examples.py index 0ee52bb34603b..6b4c5b31075f7 100644 --- a/docs/mkdocs/hooks/generate_examples.py +++ b/docs/mkdocs/hooks/generate_examples.py @@ -105,7 +105,7 @@ class Example: return fix_case(self.path.stem.replace("_", " ").title()) def generate(self) -> str: - content = f"---\ntitle: {self.title}\n---\n\n" + content = f"# {self.title}\n\n" content += f"Source .\n\n" # Use long code fence to avoid issues with diff --git a/mkdocs.yaml b/mkdocs.yaml index e5b7454003310..3a64888fb47a1 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -40,6 +40,7 @@ theme: - navigation.sections - navigation.prune - navigation.top + - navigation.indexes - search.highlight - search.share - toc.follow @@ -51,11 +52,6 @@ hooks: - docs/mkdocs/hooks/generate_argparse.py - docs/mkdocs/hooks/url_schemes.py -# Required to stop api-autonav from raising an error -# https://github.com/tlambert03/mkdocs-api-autonav/issues/16 -nav: - - api - plugins: - meta - search