Skip to content

Commit

Permalink
Improve egui_kittest docs
Browse files Browse the repository at this point in the history
- Enable all-features when generating docs
- Add x11 feature so it builds on Linux
- Add double hashes to the feature comments so document-features
  includes them in the docs
  • Loading branch information
YgorSouza committed Feb 11, 2025
1 parent 510b3cd commit 0de5460
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions crates/egui_kittest/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ include = ["../LICENSE-APACHE", "../LICENSE-MIT", "**/*.rs", "Cargo.toml"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--generate-link-to-definition"]

[features]
# Adds a wgpu-based test renderer.
## Adds a wgpu-based test renderer.
wgpu = [
"dep:egui-wgpu",
"dep:pollster",
Expand All @@ -28,12 +32,15 @@ wgpu = [
"eframe?/wgpu",
]

# Adds a dify-based image snapshot utility.
## Adds a dify-based image snapshot utility.
snapshot = ["dep:dify", "dep:image", "image/png"]

# Allows testing eframe::App
## Allows testing eframe::App
eframe = ["dep:eframe", "eframe/accesskit"]

# This is just so it compiles with `--all-features` on Linux
x11 = ["eframe?/x11"]


[dependencies]
kittest.workspace = true
Expand All @@ -50,7 +57,7 @@ wgpu = { workspace = true, features = ["metal", "dx12"], optional = true }
# snapshot dependencies
dify = { workspace = true, optional = true }

## Enable this when generating docs.
# Enable this when generating docs.
document-features = { workspace = true, optional = true }

[dev-dependencies]
Expand Down

0 comments on commit 0de5460

Please sign in to comment.