mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 06:30:19 +00:00
71c5f1e3e4
# Objective - Fix issue #2611 ## Solution - Add `--generate-link-to-definition` to all the `rustdoc-args` arrays in the `Cargo.toml`s (for docs.rs) - Add `--generate-link-to-definition` to the `RUSTDOCFLAGS` environment variable in the docs workflow (for dev-docs.bevyengine.org) - Document all the workspace crates in the docs workflow (needed because otherwise only the source code of the `bevy` package will be included, making the argument useless) - I think this also fixes #3662, since it fixes the bug on dev-docs.bevyengine.org, while on docs.rs it has been fixed for a while on their side. --- ## Changelog - The source code viewer on docs.rs now includes links to the definitions.
43 lines
1.5 KiB
TOML
43 lines
1.5 KiB
TOML
[package]
|
|
name = "bevy_diagnostic"
|
|
version = "0.15.0-dev"
|
|
edition = "2021"
|
|
description = "Provides diagnostic functionality for Bevy Engine"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["bevy"]
|
|
|
|
[features]
|
|
# Disables diagnostics that are unsupported when Bevy is dynamically linked
|
|
dynamic_linking = []
|
|
sysinfo_plugin = ["sysinfo"]
|
|
|
|
[dependencies]
|
|
# bevy
|
|
bevy_app = { path = "../bevy_app", version = "0.15.0-dev" }
|
|
bevy_core = { path = "../bevy_core", version = "0.15.0-dev" }
|
|
bevy_ecs = { path = "../bevy_ecs", version = "0.15.0-dev" }
|
|
bevy_time = { path = "../bevy_time", version = "0.15.0-dev" }
|
|
bevy_utils = { path = "../bevy_utils", version = "0.15.0-dev" }
|
|
bevy_tasks = { path = "../bevy_tasks", version = "0.15.0-dev" }
|
|
|
|
const-fnv1a-hash = "1.1.0"
|
|
|
|
# MacOS
|
|
[target.'cfg(all(target_os="macos"))'.dependencies]
|
|
# Some features of sysinfo are not supported by apple. This will disable those features on apple devices
|
|
sysinfo = { version = "0.30.0", optional = true, default-features = false, features = [
|
|
"apple-app-store",
|
|
] }
|
|
|
|
# Only include when not bevy_dynamic_plugin and on linux/windows/android
|
|
[target.'cfg(any(target_os = "linux", target_os = "windows", target_os = "android"))'.dependencies]
|
|
sysinfo = { version = "0.30.0", optional = true, default-features = false }
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[package.metadata.docs.rs]
|
|
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
|
|
all-features = true
|