Skip to content

Commit 1f4eeba

Browse files
authored
docs: auto-generate llms.txt (#209)
1 parent 4d30f6a commit 1f4eeba

File tree

3 files changed

+442
-259
lines changed

3 files changed

+442
-259
lines changed

mkdocs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ plugins:
5454
extra:
5555
show_docstring: true
5656
show_docstring_examples: true
57+
- llmstxt:
58+
full_output: llms-full.txt
59+
sections:
60+
Getting started:
61+
- index.md
62+
Usage Examples:
63+
- examples.md
64+
API Reference:
65+
- api.md
5766

5867
markdown_extensions:
5968
- pymdownx.highlight:

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ docs = [
5858
"mkdocs>=1.6",
5959
"mkdocstrings[crystal, python]>=0.29",
6060
"mkdocs-material>=9.0",
61+
"mkdocs-llmstxt>=0.2",
6162
"griffe>=1.0",
6263
"pymdown-extensions>=10.0",
6364
"griffe-fieldz>=0.2",

0 commit comments

Comments
 (0)