mirror of
https://github.com/bevyengine/bevy
synced 2024-11-21 20:23:28 +00:00
Make feature(doc_auto_cfg)
work (#12642)
# Objective - In #12366 `![cfg_attr(docsrs, feature(doc_auto_cfg))] `was added. But to apply it it needs `--cfg=docsrs` in rustdoc-args. ## Solution - Apply `--cfg=docsrs` to all crates and CI. I also added `[package.metadata.docs.rs]` to all crates to avoid adding code behind a feature and forget adding the metadata. Before: ![Screenshot 2024-03-22 at 00 51 57](https://github.com/bevyengine/bevy/assets/104745335/6a9dfdaa-8710-4784-852b-5f9b74e3522c) After: ![Screenshot 2024-03-22 at 00 51 32](https://github.com/bevyengine/bevy/assets/104745335/c5bd6d8e-8ddb-45b3-b844-5ecf9f88961c)
This commit is contained in:
parent
d836ece676
commit
72c51cdab9
91 changed files with 223 additions and 38 deletions
3
.github/workflows/docs.yml
vendored
3
.github/workflows/docs.yml
vendored
|
@ -49,6 +49,9 @@ jobs:
|
|||
echo "<meta name=\"robots\" content=\"noindex\">" > header.html
|
||||
|
||||
- name: Build docs
|
||||
env:
|
||||
# needs to be in sync with [package.metadata.docs.rs]
|
||||
RUSTDOCFLAGS: -Zunstable-options --cfg=docsrs
|
||||
run: cargo doc --all-features --no-deps -p bevy -Zunstable-options -Zrustdoc-scrape-examples
|
||||
|
||||
# This adds the following:
|
||||
|
|
|
@ -2821,5 +2821,6 @@ lto = "fat"
|
|||
panic = "abort"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
|
||||
|
|
|
@ -18,3 +18,7 @@ accesskit = "0.12"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
//! Accessibility for Bevy
|
||||
|
||||
#![forbid(unsafe_code)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Accessibility for Bevy
|
||||
|
||||
use std::sync::{
|
||||
atomic::{AtomicBool, Ordering},
|
||||
|
|
|
@ -40,3 +40,7 @@ uuid = { version = "1.7", features = ["v4"] }
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Animation for the game engine Bevy
|
||||
|
||||
mod animatable;
|
||||
|
|
|
@ -36,4 +36,5 @@ web-sys = { version = "0.3", features = ["Window"] }
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
//! This crate is about everything concerning the highest-level, application layer of a Bevy app.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate is about everything concerning the highest-level, application layer of a Bevy app.
|
||||
|
||||
mod app;
|
||||
mod main_schedule;
|
||||
mod plugin;
|
||||
|
|
|
@ -61,4 +61,5 @@ bevy_log = { path = "../bevy_log", version = "0.14.0-dev" }
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -20,3 +20,7 @@ quote = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use bevy_macro_utils::BevyManifest;
|
||||
use proc_macro::{Span, TokenStream};
|
||||
|
|
|
@ -52,4 +52,5 @@ android_shared_stdcxx = ["cpal/oboe-shared-stdcxx"]
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
#![forbid(unsafe_code)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Audio support for the game engine Bevy
|
||||
//!
|
||||
//! ```no_run
|
||||
|
@ -19,8 +22,6 @@
|
|||
//! });
|
||||
//! }
|
||||
//! ```
|
||||
#![forbid(unsafe_code)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod audio;
|
||||
mod audio_output;
|
||||
|
|
|
@ -21,3 +21,7 @@ encase = { version = "0.7", default-features = false }
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Representations of colors in various color spaces.
|
||||
//!
|
||||
//! This crate provides a number of color representations, including:
|
||||
|
|
|
@ -37,4 +37,5 @@ crossbeam-channel = "0.5.0"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
//! This crate provides core functionality for Bevy Engine.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate provides core functionality for Bevy Engine.
|
||||
|
||||
mod name;
|
||||
#[cfg(feature = "serialize")]
|
||||
mod serde;
|
||||
|
|
|
@ -42,4 +42,5 @@ nonmax = "0.5"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -19,3 +19,7 @@ syn = { version = "2.0", features = ["full"] }
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
extern crate proc_macro;
|
||||
|
||||
|
|
|
@ -43,4 +43,5 @@ ron = { version = "0.8.0", optional = true }
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,6 +1,7 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate provides additional utilities for the [Bevy game engine](https://bevyengine.org),
|
||||
//! focused on improving developer experience.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use bevy_app::prelude::*;
|
||||
|
||||
|
|
|
@ -38,4 +38,5 @@ sysinfo = { version = "0.30.0", optional = true, default-features = false }
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -16,3 +16,7 @@ bevy_internal = { path = "../bevy_internal", version = "0.14.0-dev", default-fea
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
#![allow(clippy::single_component_path_imports)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Forces dynamic linking of Bevy.
|
||||
//!
|
||||
|
@ -51,4 +51,5 @@
|
|||
|
||||
// Force linking of the main bevy crate
|
||||
#[allow(unused_imports)]
|
||||
#[allow(clippy::single_component_path_imports)]
|
||||
use bevy_internal;
|
||||
|
|
|
@ -18,3 +18,7 @@ thiserror = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Bevy's dynamic plugin loading functionality.
|
||||
//!
|
||||
//! This crate allows loading dynamic libraries (`.dylib`, `.so`) that export a single
|
||||
|
|
|
@ -51,4 +51,5 @@ path = "examples/change_detection.rs"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -17,3 +17,7 @@ proc-macro2 = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
extern crate proc_macro;
|
||||
|
||||
|
|
|
@ -17,3 +17,7 @@ encase_derive_impl = "0.7"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use bevy_macro_utils::BevyManifest;
|
||||
use encase_derive_impl::{implement, syn};
|
||||
|
|
|
@ -22,3 +22,7 @@ thiserror = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Systems and type definitions for gamepad handling in Bevy.
|
||||
//!
|
||||
//! This crate is built on top of [GilRs](gilrs), a library
|
||||
|
|
|
@ -34,4 +34,5 @@ bytemuck = "1.0"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -11,8 +11,6 @@ keywords = ["bevy"]
|
|||
[lib]
|
||||
proc-macro = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
bevy_macro_utils = { path = "../../bevy_macro_utils", version = "0.14.0-dev" }
|
||||
|
@ -20,3 +18,10 @@ bevy_macro_utils = { path = "../../bevy_macro_utils", version = "0.14.0-dev" }
|
|||
syn = "2.0"
|
||||
proc-macro2 = "1.0"
|
||||
quote = "1.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Derive implementations for `bevy_gizmos`.
|
||||
|
||||
use bevy_macro_utils::BevyManifest;
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate adds an immediate mode drawing api to Bevy for visual debugging.
|
||||
//!
|
||||
//! # Example
|
||||
|
@ -13,7 +15,6 @@
|
|||
//! ```
|
||||
//!
|
||||
//! See the documentation on [Gizmos](crate::gizmos::Gizmos) for more examples.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
/// System set label for the systems handling the rendering of gizmos.
|
||||
#[derive(SystemSet, Clone, Debug, Hash, PartialEq, Eq)]
|
||||
|
|
|
@ -60,4 +60,5 @@ smallvec = "1.11"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,8 +1,9 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Plugin providing an [`AssetLoader`](bevy_asset::AssetLoader) and type definitions
|
||||
//! for loading glTF 2.0 (a standard 3D scene definition format) files in Bevy.
|
||||
//!
|
||||
//! The [glTF 2.0 specification](https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html) defines the format of the glTF files.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
#[cfg(feature = "bevy_animation")]
|
||||
use bevy_animation::AnimationClip;
|
||||
|
|
|
@ -31,4 +31,5 @@ smallvec = { version = "1.11", features = ["union", "const_generics"] }
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Parent-child relationships for Bevy entities.
|
||||
//!
|
||||
//! You should use the tools in this crate
|
||||
|
@ -44,7 +46,6 @@
|
|||
//! [plugin]: HierarchyPlugin
|
||||
//! [query extension methods]: HierarchyQueryExt
|
||||
//! [world]: BuildWorldChildren
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod components;
|
||||
pub use components::*;
|
||||
|
|
|
@ -32,4 +32,5 @@ smol_str = "0.2"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Input functionality for the [Bevy game engine](https://bevyengine.org/).
|
||||
//!
|
||||
//! # Supported input devices
|
||||
//!
|
||||
//! `bevy` currently supports keyboard, mouse, gamepad, and touch inputs.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod axis;
|
||||
mod button_input;
|
||||
|
|
|
@ -207,3 +207,7 @@ bevy_dev_tools = { path = "../bevy_dev_tools", optional = true, version = "0.14.
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This module is separated into its own crate to enable simple dynamic linking for Bevy, and should not be used directly
|
||||
|
||||
/// `use bevy::prelude::*;` to import common components, bundles, and plugins.
|
||||
|
|
|
@ -40,4 +40,5 @@ tracing-wasm = "0.2.1"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate provides logging functions and configuration for [Bevy](https://bevyengine.org)
|
||||
//! apps, and automatically configures platform specific log handlers (i.e. WASM or Android).
|
||||
//!
|
||||
|
@ -9,7 +11,6 @@
|
|||
//!
|
||||
//! For more fine-tuned control over logging behavior, set up the [`LogPlugin`] or
|
||||
//! `DefaultPlugins` during app initialization.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
#[cfg(feature = "trace")]
|
||||
use std::panic;
|
||||
|
|
|
@ -19,3 +19,7 @@ proc-macro2 = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,4 +1,6 @@
|
|||
#![deny(unsafe_code)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! A collection of helper types and functions for working on macros within the Bevy ecosystem.
|
||||
|
||||
extern crate proc_macro;
|
||||
|
|
|
@ -45,4 +45,5 @@ rand = ["dep:rand"]
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Provides math types and functionality for the Bevy game engine.
|
||||
//!
|
||||
//! The commonly used types are vectors like [`Vec2`] and [`Vec3`],
|
||||
//! matrices like [`Mat2`], [`Mat3`] and [`Mat4`] and orientation representations
|
||||
//! like [`Quat`].
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod affine3;
|
||||
mod aspect_ratio;
|
||||
|
|
|
@ -22,3 +22,7 @@ name = "generate"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -6,6 +6,7 @@
|
|||
)]
|
||||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use glam::{Vec2, Vec3};
|
||||
|
||||
|
|
|
@ -20,4 +20,5 @@ console_error_panic_hook = "0.1.6"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate provides panic handlers for [Bevy](https://bevyengine.org)
|
||||
//! apps, and automatically configures platform specifics (i.e. WASM or Android).
|
||||
//!
|
||||
|
@ -5,7 +7,6 @@
|
|||
//!
|
||||
//! For more fine-tuned control over panic behavior, disable the [`PanicHandlerPlugin`] or
|
||||
//! `DefaultPlugins` during app initialization.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use bevy_app::{App, Plugin};
|
||||
|
||||
|
|
|
@ -46,4 +46,5 @@ nonmax = "0.5"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -12,3 +12,7 @@ keywords = ["bevy", "no_std"]
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
#![doc = include_str!("../README.md")]
|
||||
#![no_std]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use core::fmt::{self, Formatter, Pointer};
|
||||
use core::{
|
||||
|
|
|
@ -59,4 +59,5 @@ required-features = ["documentation"]
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -26,3 +26,7 @@ uuid = { version = "1.1", features = ["v4"] }
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate contains macros used by Bevy's `Reflect` API.
|
||||
//!
|
||||
//! The main export of this crate is the derive macro for [`Reflect`]. This allows
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Reflection in Rust.
|
||||
//!
|
||||
|
@ -467,7 +468,6 @@
|
|||
//! [orphan rule]: https://doc.rust-lang.org/book/ch10-02-traits.html#implementing-a-trait-on-a-type:~:text=But%20we%20can%E2%80%99t,implementation%20to%20use.
|
||||
//! [`bevy_reflect_derive/documentation`]: bevy_reflect_derive
|
||||
//! [derive `Reflect`]: derive@crate::Reflect
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod array;
|
||||
mod fields;
|
||||
|
|
|
@ -122,4 +122,5 @@ wasm-bindgen = "0.2"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -20,3 +20,7 @@ quote = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod as_bind_group;
|
||||
mod extract_component;
|
||||
|
|
|
@ -40,4 +40,5 @@ rmp-serde = "1.1"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,9 +1,10 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Provides scene definition, instantiation and serialization/deserialization.
|
||||
//!
|
||||
//! Scenes are collections of entities and their associated components that can be
|
||||
//! instantiated or removed from a world to allow composition. Scenes can be serialized/deserialized,
|
||||
//! for example to save part of the world state to a file.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod bundle;
|
||||
mod dynamic_scene;
|
||||
|
|
|
@ -39,3 +39,7 @@ radsort = "0.1"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! Provides 2D sprite rendering functionality.
|
||||
mod bundle;
|
||||
|
|
|
@ -29,4 +29,5 @@ web-time = { version = "0.2" }
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -41,4 +41,5 @@ approx = "0.5.1"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -32,4 +32,5 @@ thiserror = "1.0"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -36,4 +36,5 @@ serialize = ["dep:serde", "bevy_math/serialize"]
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -41,8 +41,10 @@ smallvec = "1.11"
|
|||
[features]
|
||||
serialize = ["serde", "smallvec/serde"]
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! This crate contains Bevy's UI system, which can be used to create UI for both 2D and 3D games
|
||||
//! # Basic usage
|
||||
//! Spawn UI elements with [`node_bundles::ButtonBundle`], [`node_bundles::ImageBundle`], [`node_bundles::TextBundle`] and [`node_bundles::NodeBundle`]
|
||||
//! This UI is laid out with the Flexbox and CSS Grid layout models (see <https://cssreference.io/flexbox/>)
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
pub mod measurement;
|
||||
pub mod node_bundles;
|
||||
|
|
|
@ -27,3 +27,7 @@ getrandom = { version = "0.2.0", features = ["js"] }
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -15,3 +15,7 @@ proc-macro2 = "1.0"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
// FIXME(3492): remove once docs are ready
|
||||
#![allow(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use proc_macro::TokenStream;
|
||||
use quote::{format_ident, quote};
|
||||
|
|
|
@ -1,3 +1,5 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! General utilities for first-party [Bevy] engine crates.
|
||||
//!
|
||||
//! [Bevy]: https://bevyengine.org/
|
||||
|
|
|
@ -34,4 +34,5 @@ smol_str = "0.2"
|
|||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! `bevy_window` provides a platform-agnostic interface for windowing in Bevy.
|
||||
//!
|
||||
//! This crate contains types for window management and events,
|
||||
//! used by windowing implementors such as `bevy_winit`.
|
||||
//! The [`WindowPlugin`] sets up some global window-related parameters and
|
||||
//! is part of the [`DefaultPlugins`](https://docs.rs/bevy/latest/bevy/struct.DefaultPlugins.html).
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
use bevy_a11y::Focus;
|
||||
|
||||
|
|
|
@ -50,8 +50,10 @@ wasm-bindgen = { version = "0.2" }
|
|||
web-sys = "0.3"
|
||||
crossbeam-channel = "0.5"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
all-features = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,10 +1,11 @@
|
|||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! `bevy_winit` provides utilities to handle window creation and the eventloop through [`winit`]
|
||||
//!
|
||||
//! Most commonly, the [`WinitPlugin`] is used as part of
|
||||
//! [`DefaultPlugins`](https://docs.rs/bevy/latest/bevy/struct.DefaultPlugins.html).
|
||||
//! The app's [runner](bevy_app::App::runner) is set by `WinitPlugin` and handles the `winit` [`EventLoop`].
|
||||
//! See `winit_runner` for details.
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
pub mod accessibility;
|
||||
mod converters;
|
||||
|
|
|
@ -6,8 +6,13 @@ description = "Bevy's error codes"
|
|||
publish = false
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
bevy = { path = ".." }
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -34,3 +34,7 @@ label = "Bevy Example"
|
|||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
#![allow(clippy::single_component_path_imports)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
//! [![](https://bevyengine.org/assets/bevy_logo_docs.svg)](https://bevyengine.org)
|
||||
//!
|
||||
|
|
|
@ -6,8 +6,6 @@ description = "handle templated pages in Bevy repository"
|
|||
publish = false
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
toml_edit = { version = "0.22.7", default-features = false, features = [
|
||||
|
@ -17,3 +15,10 @@ tera = "1.15"
|
|||
serde = { version = "1.0", features = ["derive"] }
|
||||
bitflags = "2.3"
|
||||
hashbrown = { version = "0.14", features = ["serde"] }
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -6,9 +6,14 @@ description = "Build an example for wasm"
|
|||
publish = false
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
xshell = "0.2"
|
||||
clap = { version = "4.0", features = ["derive"] }
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -6,9 +6,13 @@ description = "CI script for Bevy"
|
|||
publish = false
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
xshell = "0.2"
|
||||
bitflags = "2.3"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
|
@ -6,8 +6,6 @@ description = "Run examples"
|
|||
publish = false
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[dependencies]
|
||||
xshell = "0.2"
|
||||
|
@ -17,3 +15,10 @@ toml_edit = { version = "0.22.7", default-features = false, features = [
|
|||
"parse",
|
||||
] }
|
||||
pbr = "1.1"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
|
||||
all-features = true
|
||||
|
|
Loading…
Reference in a new issue