docs: add MkDocs documentation with Material theme and GitHub Pages deploy
Some checks failed
docs / deploy (push) Has been cancelled

This commit is contained in:
2026-08-17 14:22:34 +03:00
parent 1608b00708
commit 8787342476
18 changed files with 1277 additions and 16 deletions

35
docs/examples.md Normal file
View File

@@ -0,0 +1,35 @@
# Examples
All examples are located in the [`examples/`](https://github.com/OlegYurchik/metaorm/tree/main/examples) directory and can be run directly:
```bash
PYTHONPATH=. .venv/bin/python examples/basic_usage.py
```
## Basic Usage
--8<-- "examples/basic_usage.py"
## DTO Usage
--8<-- "examples/dto_usage.py"
## Transactions
--8<-- "examples/transactions.py"
## Nested Transactions
--8<-- "examples/nested_transactions.py"
## Filters, Pagination & Sorting
--8<-- "examples/filter_usage.py"
## Eager Loading
--8<-- "examples/relationships.py"
## Multi-Repo Transactions
--8<-- "examples/container_usage.py"