Skip to content

Commit 20421c2

Browse files
authored
Make use of mkdocs-llmstxt (#988)
1 parent 3fa79f0 commit 20421c2

File tree

4 files changed

+56
-59
lines changed

4 files changed

+56
-59
lines changed

docs/plugins/build_llms_txt.py

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

mkdocs.yml

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,26 @@ plugins:
314314
"why-logfire/python-centric.md": "why.md"
315315
"why-logfire/sql.md": "why.md"
316316
"get-started/traces.md": "concepts.md"
317+
- llmstxt:
318+
enabled: !ENV [CI, false]
319+
full_output: llms-full.txt
320+
markdown_description: |-
321+
From the team behind Pydantic, Logfire is an observability platform built on the same belief as our
322+
open source library — that the most powerful tools can be easy to use.
323+
sections:
324+
General:
325+
- index.md
326+
- why.md
327+
- concepts.md
328+
How To - Guides:
329+
- guides/*/*.md
330+
- how-to-guides/*.md
331+
Integrations:
332+
- integrations/*.md
333+
- integrations/*/*.md
334+
Optional:
335+
- roadmap.md
336+
- release-notes.md
317337
hooks:
318338
- docs/plugins/main.py
319-
- docs/plugins/build_llms_txt.py
320339
- docs/plugins/algolia.py

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,8 @@ docs = [
182182
"mkdocstrings-python>=1.8.0",
183183
"mkdocs-redirects>=1.2.1",
184184
"griffe",
185-
"bs4>=0.0.2",
186185
"algoliasearch>=3,<4",
187-
"markdownify>=0.14.1",
186+
"mkdocs-llmstxt>=0.2.0 ; python_full_version >= '3.9'",
188187
]
189188

190189
[tool.inline-snapshot]

uv.lock

Lines changed: 35 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)