github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-08-03 18:24:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

API Reference: Do not document private modules (#9042)

Browse Source 
This PR prevents documentation of private modules in the API reference
This commit is contained in:
Eugene Yurtsev 2023-08-11 18:58:14 -04:00 committed by GitHub
parent 7edf4ca396
commit aca8cb5fba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/api_reference/create_api_rst.py
View File

@ -145,30 +145,36 @@ def _load_package_modules(
package_name = package_path.name package_name = package_path.name
for file_path in package_path.rglob("*.py"): for file_path in package_path.rglob("*.py"):
if not file_path.name.startswith("__"): if file_path.name.startswith("_"):
relative_module_name = file_path.relative_to(package_path) continue
# Get the full namespace of the module
namespace = str(relative_module_name).replace(".py", "").replace("/", ".")
# Keep only the top level namespace
top_namespace = namespace.split(".")[0]
try: relative_module_name = file_path.relative_to(package_path)
module_members = _load_module_members(
f"{package_name}.{namespace}", namespace if relative_module_name.name.startswith("_"):
continue
# Get the full namespace of the module
namespace = str(relative_module_name).replace(".py", "").replace("/", ".")
# Keep only the top level namespace
top_namespace = namespace.split(".")[0]
try:
module_members = _load_module_members(
f"{package_name}.{namespace}", namespace
)
# Merge module members if the namespace already exists
if top_namespace in modules_by_namespace:
existing_module_members = modules_by_namespace[top_namespace]
_module_members = _merge_module_members(
[existing_module_members, module_members]
) )
# Merge module members if the namespace already exists else:
if top_namespace in modules_by_namespace: _module_members = module_members
existing_module_members = modules_by_namespace[top_namespace]
_module_members = _merge_module_members(
[existing_module_members, module_members]
)
else:
_module_members = module_members
modules_by_namespace[top_namespace] = _module_members modules_by_namespace[top_namespace] = _module_members
except ImportError as e: except ImportError as e:
print(f"Error: Unable to import module '{namespace}' with error: {e}") print(f"Error: Unable to import module '{namespace}' with error: {e}")
return modules_by_namespace return modules_by_namespace
@ -222,9 +228,9 @@ Classes
""" """
for class_ in classes: for class_ in classes:
if not class_['is_public']: if not class_["is_public"]:
continue continue
if class_["kind"] == "TypedDict": if class_["kind"] == "TypedDict":
template = "typeddict.rst" template = "typeddict.rst"
elif class_["kind"] == "enum": elif class_["kind"] == "enum":