github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-18 02:33:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix api ref package tables (#25400)

Browse Source
This commit is contained in:
Bagatur 2024-08-14 10:40:16 -07:00 committed by GitHub
parent 414154fa59
commit d178fb9dc3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/api_reference/create_api_rst.py
View File

@ -319,8 +319,6 @@ def _construct_doc(
index_autosummary += f""" index_autosummary += f"""
:ref:`{module}` :ref:`{module}`
{'^' * (len(module) + 5)} {'^' * (len(module) + 5)}
.. autosummary::
""" """
if classes: if classes:
@ -331,6 +329,11 @@ def _construct_doc(
.. autosummary:: .. autosummary::
:toctree: {module} :toctree: {module}
"""
index_autosummary += """
**Classes**
.. autosummary::
""" """
for class_ in sorted(classes, key=lambda c: c["qualified_name"]): for class_ in sorted(classes, key=lambda c: c["qualified_name"]):
@ -371,6 +374,14 @@ def _construct_doc(
{fstring} {fstring}
"""
index_autosummary += f"""
**Functions**
.. autosummary::
{fstring}
""" """
if deprecated_classes: if deprecated_classes:
module_doc += f"""\ module_doc += f"""\
@ -382,6 +393,12 @@ def _construct_doc(
:toctree: {module} :toctree: {module}
""" """
index_autosummary += """
**Deprecated classes*
.. autosummary::
"""
for class_ in sorted(deprecated_classes, key=lambda c: c["qualified_name"]): for class_ in sorted(deprecated_classes, key=lambda c: c["qualified_name"]):
if class_["kind"] == "TypedDict": if class_["kind"] == "TypedDict":
template = "typeddict.rst" template = "typeddict.rst"
@ -401,6 +418,9 @@ def _construct_doc(
{class_["qualified_name"]} {class_["qualified_name"]}
"""
index_autosummary += f"""
{class_['qualified_name']}
""" """
if deprecated_functions: if deprecated_functions:
@ -417,6 +437,14 @@ def _construct_doc(
{fstring} {fstring}
"""
index_autosummary += """
**Deprecated functions**
.. autosummary::
{fstring}
""" """
docs.append((f"{module}.rst", module_doc)) docs.append((f"{module}.rst", module_doc))
docs.append(("index.rst", index_doc + index_autosummary)) docs.append(("index.rst", index_doc + index_autosummary))