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

10
docs/api_reference/create_api_rst.py
View File

@ -145,8 +145,14 @@ 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("_"):
continue
relative_module_name = file_path.relative_to(package_path) relative_module_name = file_path.relative_to(package_path)
if relative_module_name.name.startswith("_"):
continue
# Get the full namespace of the module # Get the full namespace of the module
namespace = str(relative_module_name).replace(".py", "").replace("/", ".") namespace = str(relative_module_name).replace(".py", "").replace("/", ".")
# Keep only the top level namespace # Keep only the top level namespace
@ -222,7 +228,7 @@ 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":