8000 Build `llms.txt` in documentation by petyosi · Pull Request #11405 · pydantic/pydantic · GitHub
[go: up one dir, main page]
Skip to content

Build llms.txt in documentation #11405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Viicos merged 2 commits into from
Feb 6, 2025
Merged

Build llms.txt in documentation #11405

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9299ae5
Build llms.txt
petyosi Feb 6, 2025
cff424e
Fixup
Viicos Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Fixup
  • Loading branch information
@Viicos
Viicos committed Feb 6, 2025
commit cff424e964ada07d249b6ce880bd059580201ed7
19 changes: 10 additions & 9 deletions docs/plugins/build_llms_txt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from __future__ import annotations as _annotations
from __future__ import annotations

import os
from pathlib import Path

from bs4 import BeautifulSoup
from markdownify import MarkdownConverter
Expand All @@ -9,11 +9,11 @@
from mkdocs.structure.pages import Page


def on_config(config: MkDocsConfig):
os.makedirs(config.site_dir, exist_ok=True)
llms_path = os.path.join(config.site_dir, 'llms.txt')
with open(llms_path, 'w') as f:
f.write('')
def on_config(config: MkDocsConfig) -> None:
config_dir = Path(config.site_dir)
config_dir.mkdir(parents=True, exist_ok=True)
llms_path = config_dir / 'llms.txt'
llms_path.touch()


def on_page_content(html: str, page: Page, config: MkDocsConfig, files: Files) -> str:
Expand All @@ -29,7 +29,8 @@ def on_page_content(html: str, page: Page, config: MkDocsConfig, files: Files) -
for extra in soup.find_all('table', attrs={'class': 'highlighttable'}):
extra.replace_with(BeautifulSoup(f'<pre>{extra.find("code").get_text()}</pre>', 'html.parser'))

with open(os.path.join(config.site_dir, 'llms.txt'), 'a', encoding='utf-8') as f:
f.write(MarkdownConverter().convert_soup(soup)) # type: ignore[reportUnknownMemberType]
llms_path = Path(config.site_dir) / 'llms.txt'
with llms_path.open(mode='a', encoding='utf-8') as f:
f.write(MarkdownConverter().convert_soup(soup))

return html
Loading
0