Merge pull request #259 from robjtede/docs/feature-flags

reference feature flags in docs

Author: hecrj

Cargo.toml

@@ -65,3 +65,7 @@ iced_wgpu = { version = "0.2", path = "wgpu" }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 iced_web = { version = "0.2", path = "web" }
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+features = ["image", "svg", "canvas"]

futures/Cargo.toml

@@ -30,3 +30,7 @@ optional = true
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+all-features = true

futures/src/executor/async_std.rs

@@ -3,6 +3,7 @@ use crate::Executor;
 use futures::Future;
 
 /// An `async-std` runtime.
+#[cfg_attr(docsrs, doc(cfg(feature = "async-std")))]
 #[derive(Debug)]
 pub struct AsyncStd;
 

futures/src/executor/thread_pool.rs

@@ -3,6 +3,7 @@ use crate::Executor;
 use futures::Future;
 
 /// A thread pool runtime for futures.
+#[cfg_attr(docsrs, doc(cfg(feature = "thread-pool")))]
 pub type ThreadPool = futures::executor::ThreadPool;
 
 impl Executor for futures::executor::ThreadPool {

futures/src/executor/tokio.rs

@@ -3,6 +3,7 @@ use crate::Executor;
 use futures::Future;
 
 /// A `tokio` runtime.
+#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
 pub type Tokio = tokio::runtime::Runtime;
 
 impl Executor for Tokio {

futures/src/lib.rs

@@ -4,6 +4,8 @@
 #![deny(unused_results)]
 #![forbid(unsafe_code)]
 #![forbid(rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 pub use futures;
 
 mod command;

src/lib.rs

@@ -178,6 +178,7 @@
 #![deny(unused_results)]
 #![forbid(unsafe_code)]
 #![forbid(rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 mod application;
 mod element;
 mod sandbox;

src/widget.rs

@@ -18,13 +18,22 @@
 //! [`text_input::State`]: text_input/struct.State.html
 #[cfg(not(target_arch = "wasm32"))]
 mod platform {
-    pub use iced_wgpu::widget::*;
+    pub use iced_wgpu::widget::{
+        button, checkbox, container, pane_grid, progress_bar, radio,
+        scrollable, slider, text_input,
+    };
+
+    #[cfg(feature = "canvas")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "canvas")))]
+    pub use iced_wgpu::widget::canvas;
 
+    #[cfg_attr(docsrs, doc(cfg(feature = "image")))]
     pub mod image {
         //! Display images in your user interface.
         pub use iced_winit::image::{Handle, Image};
     }
 
+    #[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
     pub mod svg {
         //! Display vector graphics in your user interface.
         pub use iced_winit::svg::{Handle, Svg};

wgpu/Cargo.toml

@@ -41,3 +41,7 @@ optional = true
 [dependencies.lyon]
 version = "0.15"
 optional = true
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+all-features = true

wgpu/src/lib.rs

@@ -25,6 +25,8 @@
 #![deny(unused_results)]
 #![forbid(unsafe_code)]
 #![forbid(rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 pub mod defaults;
 pub mod settings;
 pub mod triangle;