Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit77723fe

Browse files
ViicosKludex
andauthored
Make use ofmkdocs-llmstxt (pydantic#1427)
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
1 parent858319e commit77723fe

File tree

5 files changed

+78
-57
lines changed

5 files changed

+78
-57
lines changed

‎docs/.hooks/build_llms_txt.py

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎docs/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,24 @@ That's enough to get the following view of your agent in action:
195195

196196
See[Monitoring and Performance](logfire.md) to learn more.
197197

198+
##llms.txt
199+
200+
The PydanticAI documentation is available in the[llms.txt](https://llmstxt.org/) format.
201+
This format is defined in Markdown and suited for large language models.
202+
203+
Two formats are available:
204+
205+
-[llms.txt](https://ai.pydantic.dev/llms.txt): a file containing a brief description
206+
of the project, along with links to the different sections of the documentation. The structure
207+
of this file is described in details[here](https://llmstxt.org/#format).
208+
-[llms-full.txt](https://ai.pydantic.dev/llms-full.txt): Similar to the`llms.txt` file,
209+
but every link content is included. Note that this file may be too large for some LLMs.
210+
211+
As of today, these files*cannot* be natively leveraged by LLM frameworks or IDEs. Alternatively,
212+
an[MCP server](https://modelcontextprotocol.io/) can be implemented to properly parse the`llms.txt`
213+
file.
214+
215+
198216
##Next Steps
199217

200218
To try PydanticAI yourself, follow the instructions[in the examples](examples/index.md).

‎mkdocs.yml

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,36 @@ plugins:
214214
-url:https://typing-extensions.readthedocs.io/en/latest/objects.inv
215215
-url:https://rich.readthedocs.io/en/stable/objects.inv
216216
# waiting for https://github.com/encode/httpx/discussions/3091#discussioncomment-11205594
217+
-llmstxt:
218+
enabled:!ENV [CI, false]
219+
full_output:llms-full.txt
220+
markdown_description:|-
221+
PydanticAI is a Python agent framework designed to make it less painful to build production grade
222+
applications with Generative AI.
223+
sections:
224+
Concepts documentation:
225+
-agents.md
226+
-dependencies.md
227+
-tools.md
228+
-common-tools.md
229+
-results.md
230+
-message-history.md
231+
-multi-agent-applications.md
232+
Models:
233+
-models/*.md
234+
Graphs:
235+
-graph.md
236+
Evals:
237+
-evals.md
238+
MCP:
239+
-mcp/*.md
240+
Optional:
241+
-testing.md
242+
-cli.md
243+
-logfire.md
244+
-examples/*.md
245+
217246

218247
hooks:
219248
-"docs/.hooks/main.py"
220-
-"docs/.hooks/build_llms_txt.py"
221249
-"docs/.hooks/algolia.py"

‎pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,9 @@ members = [
8383
lint = ["mypy>=1.11.2","pyright>=1.1.390","ruff>=0.6.9"]
8484
docs = [
8585
"black>=24.10.0",
86-
"bs4>=0.0.2",
87-
"markdownify>=0.14.1",
8886
"mkdocs>=1.6.1",
8987
"mkdocs-glightbox>=0.4.0",
88+
"mkdocs-llmstxt>=0.2.0",
9089
"mkdocs-material[imaging]>=9.5.45",
9190
"mkdocstrings-python>=1.12.2",
9291
]

‎uv.lock

Lines changed: 30 additions & 16 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp