From 998490cd9f297381288eb631bc98a4dfe1304f57 Mon Sep 17 00:00:00 2001 From: Harry Mellor <19981378+hmellor@users.noreply.github.com> Date: Tue, 29 Sep 2026 12:16:33 +0100 Subject: [PATCH] [Docs] Speed up docs build ~5x (#58705) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 --- docs/mkdocs/overrides/partials/nav.html | 34 +++++++++++++ mkdocs.yaml | 10 ---- requirements/docs.in | 1 - requirements/docs.txt | 66 +++++++++++-------------- 4 files changed, 63 insertions(+), 48 deletions(-) create mode 100644 docs/mkdocs/overrides/partials/nav.html diff --git a/docs/mkdocs/overrides/partials/nav.html b/docs/mkdocs/overrides/partials/nav.html new file mode 100644 index 0000000000..20a5b1fc58 --- /dev/null +++ b/docs/mkdocs/overrides/partials/nav.html @@ -0,0 +1,34 @@ + +{% import "partials/nav-item.html" as item with context %} +{% set features = features + ["navigation.prune"] %} +{% import "partials/nav-item.html" as pruned_item with context %} +{% set class = "md-nav md-nav--primary" %} +{% if "navigation.tabs" in features %} + {% set class = class ~ " md-nav--lifted" %} +{% endif %} +{% if "toc.integrate" in features %} + {% set class = class ~ " md-nav--integrated" %} +{% endif %} + diff --git a/mkdocs.yaml b/mkdocs.yaml index f3b9deab78..8c712257ee 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -65,13 +65,6 @@ plugins: - awesome-nav - glightbox - git-revision-date-localized - - minify: - minify_html: true - minify_js: true - minify_css: true - cache_safe: true - js_files: [docs/mkdocs/javascript/*.js] - css_files: [docs/mkdocs/stylesheets/*.css] # For API reference generation - api-autonav: modules: ["vllm"] @@ -98,9 +91,6 @@ plugins: summary: true inventories: - https://docs.python.org/3/objects.inv - - https://typing-extensions.readthedocs.io/en/latest/objects.inv - - https://docs.aiohttp.org/en/stable/objects.inv - - https://pillow.readthedocs.io/en/stable/objects.inv - https://numpy.org/doc/stable/objects.inv - https://pytorch.org/docs/stable/objects.inv - redirects: diff --git a/requirements/docs.in b/requirements/docs.in index 952e7c09ba..baabfa0331 100644 --- a/requirements/docs.in +++ b/requirements/docs.in @@ -6,7 +6,6 @@ mkdocs-gen-files mkdocs-awesome-nav mkdocs-glightbox mkdocs-git-revision-date-localized-plugin -mkdocs-minify-plugin mkdocs-redirects regex ruff diff --git a/requirements/docs.txt b/requirements/docs.txt index 5331a3b79b..efc92e94b5 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,40 +1,36 @@ # This file was autogenerated by uv via the following command: # uv pip compile requirements/docs.in -o requirements/docs.txt --python-platform x86_64-manylinux_2_28 --python-version 3.12 -annotated-types==0.7.0 +annotated-types==0.8.0 # via pydantic babel==2.18.0 # via # mkdocs-git-revision-date-localized-plugin # mkdocs-material -backrefs==7.0 +backrefs==8.0 # via mkdocs-material -bracex==2.6 +bracex==3.0.1 # via wcmatch -certifi==2026.4.22 +certifi==2026.7.22 # via requests -charset-normalizer==3.4.7 +charset-normalizer==3.5.1 # via requests -click==8.3.3 +click==8.5.0 # via # mkdocs # properdocs colorama==0.4.6 # via mkdocs-material -csscompressor==0.9.5 - # via mkdocs-minify-plugin ghp-import==2.1.0 # via # mkdocs # properdocs gitdb==4.0.12 # via gitpython -gitpython==3.1.50 +gitpython==3.1.62 # via mkdocs-git-revision-date-localized-plugin -griffelib==2.0.2 +griffelib==2.3.0 # via mkdocstrings-python -htmlmin2==0.1.13 - # via mkdocs-minify-plugin -idna==3.13 +idna==3.20 # via requests jinja2==3.1.6 # via @@ -42,9 +38,7 @@ jinja2==3.1.6 # mkdocs-material # mkdocstrings # properdocs -jsmin==3.0.1 - # via mkdocs-minify-plugin -markdown==3.10.2 +markdown==3.10.3 # via # mkdocs # mkdocs-autorefs @@ -72,7 +66,6 @@ mkdocs==1.6.1 # mkdocs-gen-files # mkdocs-git-revision-date-localized-plugin # mkdocs-material - # mkdocs-minify-plugin # mkdocs-redirects # mkdocstrings mkdocs-api-autonav==0.4.0 @@ -87,21 +80,19 @@ mkdocs-gen-files==0.6.1 # via -r requirements/docs.in mkdocs-get-deps==0.2.2 # via mkdocs -mkdocs-git-revision-date-localized-plugin==1.5.1 +mkdocs-git-revision-date-localized-plugin==1.6.0 # via -r requirements/docs.in mkdocs-glightbox==0.5.2 # via -r requirements/docs.in -mkdocs-material==9.7.6 +mkdocs-material==9.7.7 # via -r requirements/docs.in mkdocs-material-extensions==1.3.1 # via mkdocs-material -mkdocs-minify-plugin==0.8.0 - # via -r requirements/docs.in mkdocs-redirects==1.2.3 # via -r requirements/docs.in -mkdocstrings==1.0.4 +mkdocstrings==1.0.6 # via mkdocstrings-python -mkdocstrings-python==2.0.3 +mkdocstrings-python==2.0.8 # via # -r requirements/docs.in # mkdocs-api-autonav @@ -109,9 +100,10 @@ msgspec==0.21.1 # via -r requirements/docs.in natsort==8.4.0 # via mkdocs-awesome-nav -packaging==26.2 +packaging==26.3 # via # mkdocs + # mkdocs-git-revision-date-localized-plugin # properdocs paginate==0.5.7 # via mkdocs-material @@ -119,7 +111,7 @@ pathspec==1.1.1 # via # mkdocs # properdocs -platformdirs==4.9.6 +platformdirs==4.11.12 # via # mkdocs-get-deps # properdocs @@ -127,15 +119,15 @@ properdocs==1.6.7 # via # mkdocs-gen-files # mkdocs-redirects -pydantic==2.13.4 +pydantic==2.13.5 # via # -r requirements/docs.in # mkdocs-awesome-nav -pydantic-core==2.46.4 +pydantic-core==2.46.5 # via pydantic -pygments==2.20.0 +pygments==2.21.0 # via mkdocs-material -pymdown-extensions==10.21.2 +pymdown-extensions==12.0.1 # via # mkdocs-material # mkdocstrings @@ -153,30 +145,30 @@ pyyaml-env-tag==1.1 # via # mkdocs # properdocs -regex==2026.4.4 +regex==2026.9.10 # via -r requirements/docs.in -requests==2.33.1 +requests==2.34.2 # via mkdocs-material -ruff==0.15.12 +ruff==0.16.8 # via -r requirements/docs.in -selectolax==0.4.8 +selectolax==0.4.12 # via mkdocs-glightbox six==1.17.0 # via python-dateutil smmap==5.0.3 # via gitdb -typing-extensions==4.15.0 +typing-extensions==4.16.0 # via # pydantic # pydantic-core # typing-inspection -typing-inspection==0.4.2 +typing-inspection==0.4.4 # via pydantic -urllib3==2.6.3 +urllib3==2.8.0 # via requests watchdog==6.0.0 # via # mkdocs # properdocs -wcmatch==10.1 +wcmatch==11.0.1 # via mkdocs-awesome-nav