Commit f163d7cb by Ching Chow Committed by Sébastien Eustace

Documentation update (#362)

* Document trove classifiers

* Fix incorrect key name

* Resolve markdownlint blank line issues

* Fix typo
parent 6e6aed6a
......@@ -10,18 +10,20 @@ This file can typically be found in one of the following directories:
For Unix, we follow the XDG spec and support `$XDG_CONFIG_HOME`.
That means, by default `~/.config/pypoetry`
## Available settings
### `settings.virtualenvs.create`: boolean
Create a new virtualenv if one doesn't already exist.
Defaults to `true`.
### `settings.virtualenvs.in-project`: boolean
Create the virtualenv inside the project's root directory.
Defaults to `false`.
### `settings.virtualenvs.path`: string
Directory where virtualenvs will be created.
Defaults to one of the following directories:
......@@ -29,5 +31,6 @@ Defaults to one of the following directories:
- Windows: `C:\Users\<username>\AppData\Local\pypoetry\Cache/virtualenvs`
- Unix: `~/.cache/pypoetry/virtualenvs`
### `repository.<name>`: string
### `repositories.<name>`: string
Set a new alternative repository. See [Repositories](/repositories/) for more information.
......@@ -68,6 +68,25 @@ An URL to the documentation of the project. **Optional**
A list of keywords (max: 5) that the package is related to. **Optional**
## classifiers
A list of PyPI [trove classifiers](https://pypi.org/classifiers/) that describe the project. **Optional**
```toml
[tool.poetry]
# ...
classifiers = [
"Topic :: Software Development :: Build Tools",
"Topic :: Software Development :: Libraries :: Python Modules"
]
```
!!!note
Note that Python classifiers are still automatically added for you and are determined by your `python` requirement.
The `license` property will also set the License classifier automatically.
## packages
A list of packages and modules to include in the final distribution.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment