From c051a8c1399ffcb4151f5153e26df653c6b2064c Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 11 Nov 2025 09:16:01 +0100 Subject: [PATCH 1/2] docs: Added llms.txt --- README.md | 2 +- docs/index.md | 8 ++++++++ mkdocs.yml | 37 +++++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- 4 files changed, 47 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2dbe782..a063867 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![PyPI Downloads](https://static.pepy.tech/badge/that-depends/month)](https://pepy.tech/projects/that-depends) [![GitHub stars](https://img.shields.io/github/stars/modern-python/that-depends)](https://github.com/modern-python/that-depends/stargazers) [![libs.tech recommends](https://libs.tech/project/773446541/badge.svg)](https://libs.tech/project/773446541/that-depends) - +[![llms.txt](https://img.shields.io/badge/llms.txt-green)](https://that-depends.readthedocs.io/llms.txt) Dependency injection framework for Python. It is production-ready and gives you the following: diff --git a/docs/index.md b/docs/index.md index 57505ff..230fe14 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,3 +67,11 @@ await some_foo() # "async resource" ``` See the [injection documentation](introduction/injection.md) for more information. + +## llms.txt + + + +`that-depends` provides a [llms.txt](https://that-depends.readthedocs.io/llms.txt) file. + +You can find documentation on how to use it [here](https://llmstxt.org/). diff --git a/mkdocs.yml b/mkdocs.yml index 0226005..06d2483 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -96,6 +96,43 @@ markdown_extensions: extra_css: - css/code.css +plugins: + - llmstxt: + full_output: llms-full.txt + markdown_description: "A simple dependency injection framework for python." + sections: + Quickstart: + - index.md: How to install and basic usage example + Containers: + - introduction/ioc-container.md: Defining the DI Container + - introduction/multiple-containers.md: Using multiple DI Containers + Injecting Dependencies: + - introduction/injection.md: Default way to inject dependencies + - introduction/generator-injection.md: Injecting dependencies into generators + - introduction/type-based-injection.md: Injecting dependencies by bound type + - introduction/string-injection.md: Injecting dependencies by providing a reference to a Provider by string + Simple Providers: + - providers/singleton.md: The Singleton and AsyncSingleton provider + - providers/factories.md: The Factory and AsyncFactory provider + - providers/object.md: The Object provider + - providers/resources.md: The Resource and AsyncResource provider + - introduction/tear-down.md: Handling tear down for Singletons and Resources + Context Providers: + - providers/context-resources.md: The ContextResource provider + - introduction/scopes.md: Handling scopes with ContextResources + - providers/state.md: The State provider + Providers that interact with other providers: + - providers/collections.md: The Dict and List provider + - providers/selector.md: The Selector provider + Integrations with other Frameworks: + - integrations/fastapi.md: Integration with FastApi + - integrations/faststream.md: Integration with FastStream + - integrations/litestar.md: Integration with LiteStar + Testing: + - testing/fixture.md: Usage with fixtures + - testing/provider-overriding.md: Overriding providers + Experimental features: + - experimental/lazy.md: The Lazy provider extra: social: diff --git a/pyproject.toml b/pyproject.toml index 398e1a1..8cee342 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,11 +42,11 @@ dev = [ "mypy", "typing-extensions", "pre-commit", - # integrations tests "litestar", "faststream[nats]", "mkdocs>=1.6.1", "pytest-randomly", + "mkdocs-llmstxt>=0.4.0", ] [build-system] From e7e8ccb2f6addeffa1b8e917d854a2275e71ab71 Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 11 Nov 2025 09:20:18 +0100 Subject: [PATCH 2/2] docs: Minor fixes. --- docs/index.md | 2 -- mkdocs.yml | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 230fe14..674f383 100644 --- a/docs/index.md +++ b/docs/index.md @@ -70,8 +70,6 @@ See the [injection documentation](introduction/injection.md) for more informatio ## llms.txt - - `that-depends` provides a [llms.txt](https://that-depends.readthedocs.io/llms.txt) file. You can find documentation on how to use it [here](https://llmstxt.org/). diff --git a/mkdocs.yml b/mkdocs.yml index 06d2483..01db70c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -99,7 +99,7 @@ extra_css: plugins: - llmstxt: full_output: llms-full.txt - markdown_description: "A simple dependency injection framework for python." + markdown_description: "A simple dependency injection framework for Python." sections: Quickstart: - index.md: How to install and basic usage example