Skip to content

Commit 70628dc

Browse files
committed
docs: add a toml snippet with a full example to copy
1 parent 42527fa commit 70628dc

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/user_guide/all_settings.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,24 @@ Here's a list of all the settings, including those that are simpler but equally
5353
### Strategy Generator
5454

5555
`strategy_generator_path` - `str` (default: `"smyth.runner.strategy.first_warm"`) Read more about [dispatch strategies here](concurrency.md/#dispatch-strategy).
56+
57+
58+
## `pyproject.toml` example
59+
60+
```toml title='pyproject.toml' linenums="1"
61+
[tool.smyth]
62+
host = "0.0.0.0"
63+
port = 8080
64+
log_level = "INFO"
65+
smyth_path_prefix = "/smyth"
66+
67+
[tool.smyth.handlers.lambda_handler]
68+
handler_path = "nimara_search_algolia_backend.app.lambda_handler"
69+
url_path = "{path:path}"
70+
timeout = 300
71+
event_data_function_path = "smyth.event.generate_api_gw_v2_event_data"
72+
context_data_function_path = "smyth.context.generate_context_data"
73+
log_level = "DEBUG"
74+
concurrency = 3
75+
strategy_generator_path = "smyth.runner.strategy.first_warm"
76+
```

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Source = "https://github.com/mirumee/smyth"
4848
[project.optional-dependencies]
4949
dev = ["ipdb"]
5050
types = ["mypy>=1.0.0", "pytest", "types-toml", "pytest-asyncio"]
51-
docs = ["mkdocs-material", "termynal"]
51+
docs = ["mkdocs-material~=9.0", "termynal"]
5252

5353
[tool.hatch.version]
5454
path = "src/smyth/__about__.py"

0 commit comments

Comments
 (0)