From 791d7e965e5cec1e5056c80a64d06a688e3cd808 Mon Sep 17 00:00:00 2001 From: Erick Friis Date: Fri, 6 Dec 2024 13:23:06 -0800 Subject: [PATCH] docs: enable private docstring modules sphinx (#28588) --- docs/api_reference/create_api_rst.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/api_reference/create_api_rst.py b/docs/api_reference/create_api_rst.py index 0635dbb7ff8..1d4a35b9f0d 100644 --- a/docs/api_reference/create_api_rst.py +++ b/docs/api_reference/create_api_rst.py @@ -72,9 +72,14 @@ def _load_module_members(module_path: str, namespace: str) -> ModuleMembers: Returns: list: A list of loaded module objects. """ + classes_: List[ClassInfo] = [] functions: List[FunctionInfo] = [] module = importlib.import_module(module_path) + + if ":private:" in (module.__doc__ or ""): + return ModuleMembers(classes_=[], functions=[]) + for name, type_ in inspect.getmembers(module): if not hasattr(type_, "__module__"): continue