docs: enable private docstring modules sphinx (#28588)

This commit is contained in:
Erick Friis 2024-12-06 13:23:06 -08:00 committed by GitHub
parent 4f99952129
commit 791d7e965e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -72,9 +72,14 @@ def _load_module_members(module_path: str, namespace: str) -> ModuleMembers:
Returns: Returns:
list: A list of loaded module objects. list: A list of loaded module objects.
""" """
classes_: List[ClassInfo] = [] classes_: List[ClassInfo] = []
functions: List[FunctionInfo] = [] functions: List[FunctionInfo] = []
module = importlib.import_module(module_path) module = importlib.import_module(module_path)
if ":private:" in (module.__doc__ or ""):
return ModuleMembers(classes_=[], functions=[])
for name, type_ in inspect.getmembers(module): for name, type_ in inspect.getmembers(module):
if not hasattr(type_, "__module__"): if not hasattr(type_, "__module__"):
continue continue