Skip to content

Commit 0b957dd

Browse files
committed
docs: add llms.txt
1 parent 33eb374 commit 0b957dd

3 files changed

Lines changed: 74 additions & 4 deletions

File tree

mkdocs.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ repo_name: "brian14708/duron"
55
nav:
66
- Home:
77
- index.md
8-
- Reference:
8+
- Reference: &references
99
- reference/duron.md
1010
- reference/log.md
1111
- reference/codec.md
@@ -45,13 +45,17 @@ plugins:
4545
separate_signature: true
4646
merge_init_into_class: true
4747
members: true
48+
docstring_section_style: list
4849
inventories:
4950
- https://docs.python.org/3/objects.inv
5051
- https://typing-extensions.readthedocs.io/en/latest/objects.inv
5152
- mermaid2:
5253
arguments:
5354
theme: |
5455
^(window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'
56+
- llmstxt:
57+
sections:
58+
API Reference: *references
5559
markdown_extensions:
5660
- pymdownx.superfences:
5761
custom_fences:

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ lint = [
5555
]
5656
docs = [
5757
"mkdocs",
58+
"mkdocs-llmstxt",
5859
"mkdocs-material",
5960
"mkdocs-mermaid2-plugin",
6061
"mkdocstrings[python]",

uv.lock

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

0 commit comments

Comments
 (0)