mirror of https://github.com/pypa/hatch.git
31 lines
890 B
Markdown
31 lines
890 B
Markdown
# Environment collector plugins
|
|
|
|
-----
|
|
|
|
Environment collectors allow for dynamically modifying environments or adding environments beyond those defined in config. Users can override default values provided by each environment.
|
|
|
|
## Known third-party
|
|
|
|
- [hatch-mkdocs](https://github.com/mkdocs/hatch-mkdocs) - integrate [MkDocs](https://github.com/mkdocs/mkdocs) and infer dependencies into an env
|
|
|
|
## Installation
|
|
|
|
Any required environment collectors that are not built-in must be manually installed alongside Hatch or listed in the `tool.hatch.env.requires` array for automatic management:
|
|
|
|
```toml config-example
|
|
[tool.hatch.env]
|
|
requires = [
|
|
"...",
|
|
]
|
|
```
|
|
|
|
::: hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface
|
|
options:
|
|
members:
|
|
- PLUGIN_NAME
|
|
- root
|
|
- config
|
|
- get_initial_config
|
|
- finalize_config
|
|
- finalize_environments
|