-
Notifications
You must be signed in to change notification settings - Fork 15.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
linting lower-case letter links fixed /contributing link update
- Loading branch information
Showing
7 changed files
with
244 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
import json | ||
import os | ||
import re | ||
import string | ||
import sys | ||
from collections import defaultdict | ||
from pathlib import Path | ||
|
||
|
||
def extract_titles(input_dir: str) -> list[dict[str, str]]: | ||
titles = [] | ||
title_pattern = re.compile(r"^# (.+)") # Pattern to match '# Title' format | ||
|
||
# Traverse all files in the directory | ||
for filename in os.listdir(input_dir): | ||
file_path = os.path.join(input_dir, filename) | ||
|
||
if filename.endswith((".md", ".mdx")): | ||
# Open markdown files and extract title | ||
with open(file_path, "r", encoding="utf-8") as file: | ||
for line in file: | ||
match = title_pattern.match(line) | ||
if match: | ||
title = match.group(1) | ||
titles.append({"file": filename, "title": title}) | ||
break # Stop after the first title line | ||
|
||
elif filename.endswith(".ipynb"): | ||
# Open Jupyter Notebook files and extract title | ||
with open(file_path, "r", encoding="utf-8") as file: | ||
notebook_data = json.load(file) | ||
# Search in notebook cells for the title | ||
for cell in notebook_data.get("cells", []): | ||
if cell.get("cell_type") == "markdown": | ||
for line in cell.get("source", []): | ||
match = title_pattern.match(line) | ||
if match: | ||
title = match.group(1) | ||
titles.append({"file": filename, "title": title}) | ||
break | ||
if titles and titles[-1]["file"] == filename: | ||
break # Stop after finding the first title in the notebook | ||
|
||
return titles | ||
|
||
|
||
def transform_to_links(titles: list[dict[str, str]], prefix: str) -> list[str]: | ||
return [ | ||
f"[{title['title']}]({prefix}{title['file'].split('.')[0]})" for title in titles | ||
] | ||
|
||
|
||
def generate_index_page(items: list[str], num_columns: int = 5) -> str: | ||
# Group items by their starting letter (the second character in the string) | ||
grouped_items = defaultdict(list) | ||
for item in items: | ||
first_letter = item[1].upper() | ||
if first_letter in string.ascii_uppercase: | ||
grouped_items[first_letter].append(item) | ||
else: | ||
grouped_items["0-9"].append(item) # Non-alphabetical characters go here | ||
|
||
# Sort groups by letters A-Z | ||
sorted_groups = sorted(grouped_items.items()) | ||
|
||
# Generate Markdown content | ||
content = [ | ||
"""--- | ||
hide_table_of_contents: true | ||
--- | ||
# Providers | ||
:::info | ||
If you'd like to write your own integration, see [Extending LangChain](/docs/how_to/#custom). | ||
If you'd like to contribute an integration, see [Contributing integrations](/docs/contributing/how_to/integrations/). | ||
::: | ||
""", | ||
] | ||
# First part: Menu with links | ||
menu_links = " | ".join( | ||
f"[{letter}](#{letter.lower()})" for letter, _ in sorted_groups | ||
) | ||
content.append(menu_links + "\n\n") | ||
content.append("\n---\n\n") | ||
|
||
# Second part: Grouped items in a single line with separators | ||
for letter, items in sorted_groups: | ||
content.append(f"### {letter}\n\n") | ||
# Sort items within each group and join them in a single line with " | " separator | ||
items_line = " | ".join(sorted(items, key=str.casefold)) | ||
content.append(items_line + "\n\n") | ||
|
||
return "".join(content) | ||
|
||
|
||
if __name__ == "__main__": | ||
DOCS_DIR = Path(__file__).parents[1] | ||
providers_dir = DOCS_DIR / "docs" / "integrations" / "providers" | ||
# "all.mdx" is used for `providers` root directory menu | ||
output_file = providers_dir / "all.mdx" | ||
|
||
titles = extract_titles(providers_dir) | ||
links = transform_to_links(titles=titles, prefix="/docs/integrations/providers/") | ||
mdx_page = generate_index_page(items=links) | ||
with open(output_file, "w") as f: | ||
f.write(mdx_page) | ||
print(f"{output_file} generated successfully") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters