From 982b2580f40bd300b7570b7ec8b5cc2889c4b25c Mon Sep 17 00:00:00 2001 From: YgorSouza <43298013+YgorSouza@users.noreply.github.com> Date: Wed, 12 Feb 2025 14:20:15 +0100 Subject: [PATCH] Enable all features for egui_kittest docs (#5711) - 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 * Closes * [x] I have followed the instructions in the PR template --- crates/egui_kittest/Cargo.toml | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/crates/egui_kittest/Cargo.toml b/crates/egui_kittest/Cargo.toml index 1e4af19e..ef38ebd3 100644 --- a/crates/egui_kittest/Cargo.toml +++ b/crates/egui_kittest/Cargo.toml @@ -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", @@ -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 @@ -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]