From 022afbeb4efa22bb8a4656a2712cd66c6a811c23 Mon Sep 17 00:00:00 2001 From: Harry Mellor <19981378+hmellor@users.noreply.github.com> Date: Wed, 7 May 2025 01:36:41 +0100 Subject: [PATCH] Fix doc build performance (#17748) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> --- docs/source/conf.py | 3 --- requirements/docs.txt | 5 ++++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 060649e43b96b..5620d6de2c59b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -60,9 +60,6 @@ autodoc2_packages = [ autodoc2_output_dir = "api" autodoc2_render_plugin = "myst" autodoc2_hidden_objects = ["dunder", "private", "inherited"] -autodoc2_docstring_parser_regexes = [ - (".*", "docs.source.autodoc2_docstring_parser"), -] autodoc2_sort_names = True autodoc2_index_template = None diff --git a/requirements/docs.txt b/requirements/docs.txt index 385de841691cc..ccc5ef0aa9785 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,6 +1,5 @@ sphinx==7.4.7 sphinx-argparse==0.5.2 -sphinx-autodoc2==0.5.0 sphinx-book-theme==1.1.4 sphinx-copybutton==0.5.2 sphinx-design==0.6.1 @@ -9,6 +8,10 @@ myst-parser==3.0.1 # `myst-parser==4.0.1` breaks inline code in titles msgspec commonmark # Required by sphinx-argparse when using :markdownhelp: +# Custom autodoc2 is necessary for faster docstring processing +# see: https://github.com/sphinx-extensions2/sphinx-autodoc2/issues/33#issuecomment-2856386035 +git+https://github.com/hmellor/sphinx-autodoc2.git # sphinx-autodoc2==0.5.0 + # packages to install to build the documentation cachetools -f https://download.pytorch.org/whl/cpu