mirror of
https://github.com/bevyengine/bevy
synced 2025-01-06 18:28:59 +00:00
f096ad4155
# Objective Currently the built docs only shows the logo and favicon for the top level `bevy` crate. This makes views like https://docs.rs/bevy_ecs/latest/bevy_ecs/ look potentially unrelated to the project at first glance. ## Solution Reproduce the docs attributes for every crate that Bevy publishes. Ideally this would be done with some workspace level Cargo.toml control, but AFAICT, such support does not exist.
59 lines
1.9 KiB
Rust
59 lines
1.9 KiB
Rust
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
#![doc(
|
|
html_logo_url = "https://bevyengine.org/assets/icon.png",
|
|
html_favicon_url = "https://bevyengine.org/assets/icon.png"
|
|
)]
|
|
|
|
//! Forces dynamic linking of Bevy.
|
|
//!
|
|
//! Dynamic linking causes Bevy to be built and linked as a dynamic library. This will make
|
|
//! incremental builds compile much faster.
|
|
//!
|
|
//! # Warning
|
|
//!
|
|
//! Do not enable this feature for release builds because this would require you to ship
|
|
//! `libstd.so` and `libbevy_dylib.so` with your game.
|
|
//!
|
|
//! # Enabling dynamic linking
|
|
//!
|
|
//! ## The recommended way
|
|
//!
|
|
//! The easiest way to enable dynamic linking is to use the `--features bevy/dynamic_linking` flag when
|
|
//! using the `cargo run` command:
|
|
//!
|
|
//! `cargo run --features bevy/dynamic_linking`
|
|
//!
|
|
//! ## The unrecommended way
|
|
//!
|
|
//! It is also possible to enable the `dynamic_linking` feature inside of the `Cargo.toml` file. This is
|
|
//! unrecommended because it requires you to remove this feature every time you want to create a
|
|
//! release build to avoid having to ship additional files with your game.
|
|
//!
|
|
//! To enable dynamic linking inside of the `Cargo.toml` file add the `dynamic_linking` feature to the
|
|
//! bevy dependency:
|
|
//!
|
|
//! `features = ["dynamic_linking"]`
|
|
//!
|
|
//! ## The manual way
|
|
//!
|
|
//! Manually enabling dynamic linking is achieved by adding `bevy_dylib` as a dependency and
|
|
//! adding the following code to the `main.rs` file:
|
|
//!
|
|
//! ```
|
|
//! #[allow(unused_imports)]
|
|
//! use bevy_dylib;
|
|
//! ```
|
|
//!
|
|
//! It is recommended to disable the `bevy_dylib` dependency in release mode by adding the
|
|
//! following code to the `use` statement to avoid having to ship additional files with your game:
|
|
//!
|
|
//! ```
|
|
//! #[allow(unused_imports)]
|
|
//! #[cfg(debug_assertions)] // new
|
|
//! use bevy_dylib;
|
|
//! ```
|
|
|
|
// Force linking of the main bevy crate
|
|
#[allow(unused_imports)]
|
|
#[allow(clippy::single_component_path_imports)]
|
|
use bevy_internal;
|