Skip to content

Commit 91cad80

Browse files
authored
docs: Added llms.txt (#206)
1 parent 5b45296 commit 91cad80

4 files changed

Lines changed: 45 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![PyPI Downloads](https://static.pepy.tech/badge/that-depends/month)](https://pepy.tech/projects/that-depends)
77
[![GitHub stars](https://img.shields.io/github/stars/modern-python/that-depends)](https://github.com/modern-python/that-depends/stargazers)
88
[![libs.tech recommends](https://libs.tech/project/773446541/badge.svg)](https://libs.tech/project/773446541/that-depends)
9-
9+
[![llms.txt](https://img.shields.io/badge/llms.txt-green)](https://that-depends.readthedocs.io/llms.txt)
1010
Dependency injection framework for Python.
1111

1212
It is production-ready and gives you the following:

docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,9 @@ await some_foo() # "async resource"
6767
```
6868

6969
See the [injection documentation](introduction/injection.md) for more information.
70+
71+
## llms.txt
72+
73+
`that-depends` provides a [llms.txt](https://that-depends.readthedocs.io/llms.txt) file.
74+
75+
You can find documentation on how to use it [here](https://llmstxt.org/).

mkdocs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,43 @@ markdown_extensions:
9696

9797
extra_css:
9898
- css/code.css
99+
plugins:
100+
- llmstxt:
101+
full_output: llms-full.txt
102+
markdown_description: "A simple dependency injection framework for Python."
103+
sections:
104+
Quickstart:
105+
- index.md: How to install and basic usage example
106+
Containers:
107+
- introduction/ioc-container.md: Defining the DI Container
108+
- introduction/multiple-containers.md: Using multiple DI Containers
109+
Injecting Dependencies:
110+
- introduction/injection.md: Default way to inject dependencies
111+
- introduction/generator-injection.md: Injecting dependencies into generators
112+
- introduction/type-based-injection.md: Injecting dependencies by bound type
113+
- introduction/string-injection.md: Injecting dependencies by providing a reference to a Provider by string
114+
Simple Providers:
115+
- providers/singleton.md: The Singleton and AsyncSingleton provider
116+
- providers/factories.md: The Factory and AsyncFactory provider
117+
- providers/object.md: The Object provider
118+
- providers/resources.md: The Resource and AsyncResource provider
119+
- introduction/tear-down.md: Handling tear down for Singletons and Resources
120+
Context Providers:
121+
- providers/context-resources.md: The ContextResource provider
122+
- introduction/scopes.md: Handling scopes with ContextResources
123+
- providers/state.md: The State provider
124+
Providers that interact with other providers:
125+
- providers/collections.md: The Dict and List provider
126+
- providers/selector.md: The Selector provider
127+
Integrations with other Frameworks:
128+
- integrations/fastapi.md: Integration with FastApi
129+
- integrations/faststream.md: Integration with FastStream
130+
- integrations/litestar.md: Integration with LiteStar
131+
Testing:
132+
- testing/fixture.md: Usage with fixtures
133+
- testing/provider-overriding.md: Overriding providers
134+
Experimental features:
135+
- experimental/lazy.md: The Lazy provider
99136

100137
extra:
101138
social:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ dev = [
4242
"mypy",
4343
"typing-extensions",
4444
"pre-commit",
45-
# integrations tests
4645
"litestar",
4746
"faststream[nats]",
4847
"mkdocs>=1.6.1",
4948
"pytest-randomly",
49+
"mkdocs-llmstxt>=0.4.0",
5050
]
5151

5252
[build-system]

0 commit comments

Comments
 (0)