skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

`eframe`: Fix building the `wasm32` docs for `docs.rs` (#3757) 

* Closes https://github.com/emilk/egui/issues/3756

Fix suggested by @morionelab
This commit is contained in:
Emil Ernerfeldt 2023-12-31 10:26:02 +01:00 committed by GitHub
parent 9951fe0d36
commit 12468438a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
crates/eframe/Cargo.toml
View File

@ -21,6 +21,7 @@ include = [
[package.metadata.docs.rs] [package.metadata.docs.rs]
all-features = true all-features = true
rustc-args = ["--cfg=web_sys_unstable_apis"]
targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"] targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"]
[lib] [lib]

19
crates/eframe/src/lib.rs
View File

@ -9,6 +9,21 @@
//! In short, you implement [`App`] (especially [`App::update`]) and then //! In short, you implement [`App`] (especially [`App::update`]) and then
//! call [`crate::run_native`] from your `main.rs`, and/or use `eframe::WebRunner` from your `lib.rs`. //! call [`crate::run_native`] from your `main.rs`, and/or use `eframe::WebRunner` from your `lib.rs`.
//! //!
//! ## Compiling for web
//! To get copy-paste working on web, you need to compile with
//! `export RUSTFLAGS=--cfg=web_sys_unstable_apis`.
//!
//! You need to install the `wasm32` target with `rustup target add wasm32-unknown-unknown`.
//!
//! Build the `.wasm` using `cargo build --target wasm32-unknown-unknown`
//! and then use [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) to generate the JavaScript glue code.
//!
//! See the [`eframe_template` repository](https://github.com/emilk/eframe_template/) for more.
//!
//! ## Simplified usage
//! If your app is only for native, and you don't need advanced features like state persistence,
//! then you can use the simpler function [`run_simple_native`].
//!
//! ## Usage, native: //! ## Usage, native:
//! ``` no_run //! ``` no_run
//! use eframe::egui; //! use eframe::egui;
@ -114,10 +129,6 @@
//! } //! }
//! ``` //! ```
//! //!
//! ## Simplified usage
//! If your app is only for native, and you don't need advanced features like state persistence,
//! then you can use the simpler function [`run_simple_native`].
//!
//! ## Feature flags //! ## Feature flags
#![cfg_attr(feature = "document-features", doc = document_features::document_features!())] #![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
//! //!