Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nim65s committed May 3, 2023
1 parent 4fa0b3a commit 9a1cfa3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

- add `--cmeel-env` option to `docker` subcommand to forward `CMEEL_*` environment variables
- improve docs

## [v0.42.1] - 2023-05-03

- `[project]` section of `pyproject.toml`:
- normalize `name`
- accept `keyword` key
- accept `keywords` key
- accept `optional-dependencies` key
- fix `readme` str key
- switch to tomllib for python >= 3.11
Expand Down
6 changes: 6 additions & 0 deletions docs/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ Everything required to configure a project is in its `pyproject.toml` file, espe
- `name`
- `version`
- `description`
- `keywords`
- `license`
- `license-files` (`["LICEN[CS]E*", "COPYING*", "NOTICE*", "AUTHORS*"]` are found by default)
- `requires-python` (cmeel will set `>=3.7` by default if this is omitted)
- in `[project.urls]` section:
- `homepage`
Expand All @@ -51,6 +53,8 @@ Cmeel packages can have dependencies on other python packages, cmeel or not. The

`cmeel` is automatically added.

Cmeel also accepts an `optional-dependencies` table for extras.

### Readme

Built wheels will ship the README file in their metadata. The provided content-type for this file will be detected as:
Expand All @@ -61,6 +65,8 @@ Built wheels will ship the README file in their metadata. The provided content-t

If this field is not present, Cmeel will try to find a `README.md`, `README.rst`, `README.txt` or a `README`.

Content-type can also be specified manually with eg. `readme = {content-type = "something", file = "readme.sth"}`

## Cmeel specific Configuration

Cmeel configuration can be provided by:
Expand Down

0 comments on commit 9a1cfa3

Please sign in to comment.