mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +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.
44 lines
1.2 KiB
TOML
44 lines
1.2 KiB
TOML
[package]
|
|
name = "bevy_log"
|
|
version = "0.15.0-dev"
|
|
edition = "2021"
|
|
description = "Provides logging for Bevy Engine"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["bevy"]
|
|
|
|
[features]
|
|
trace = ["tracing-error"]
|
|
trace_tracy_memory = ["dep:tracy-client"]
|
|
|
|
[dependencies]
|
|
bevy_app = { path = "../bevy_app", version = "0.15.0-dev" }
|
|
bevy_utils = { path = "../bevy_utils", version = "0.15.0-dev" }
|
|
bevy_ecs = { path = "../bevy_ecs", version = "0.15.0-dev" }
|
|
|
|
tracing-subscriber = { version = "0.3.1", features = [
|
|
"registry",
|
|
"env-filter",
|
|
] }
|
|
tracing-chrome = { version = "0.7.0", optional = true }
|
|
tracing-log = "0.2.0"
|
|
tracing-error = { version = "0.2.0", optional = true }
|
|
|
|
# Tracy dependency compatibility table:
|
|
# https://github.com/nagisa/rust_tracy_client
|
|
tracing-tracy = { version = "0.11.0", optional = true }
|
|
tracy-client = { version = "0.17.0", optional = true }
|
|
|
|
[target.'cfg(target_os = "android")'.dependencies]
|
|
android_log-sys = "0.3.0"
|
|
|
|
[target.'cfg(target_arch = "wasm32")'.dependencies]
|
|
tracing-wasm = "0.2.1"
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[package.metadata.docs.rs]
|
|
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
|
|
all-features = true
|