Skip to content

The agent engineering platform.

docs: enable private docstring modules sphinx (#28588)

Erick Friis791d7e965e5c
diff --git a/docs/api_reference/create_api_rst.py b/docs/api_reference/create_api_rst.py
index 0635dbb7ff..1d4a35b9f0 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