mirror of
https://github.com/tokio-rs/tracing.git
synced 2025-10-02 07:20:35 +00:00
3d96c0fe97
Depends on #1881 Right now, the `valuable` stuff isn't very discoverable --- enabling the feature just adds some trait impls and stuff that aren't particularly visible in the documentation. This PR adds some top-level docs on using `valuable`. In particular: - Added a section to the `tracing` and `tracing-core` lib.rs docs explaining the unstable features versioning policy and how to turn on unstable features - Added a section in the `field` module that explains how to use `valuable` to record fields. - It turns out the `tracing::field` module didn't really have docs, since it doesn't re-export the `tracing_core::field` module but re-exports its _types_ in a new module (because it adds a trait). It had a single line of docs that just said something about "structured key-value data". I fixed this by coping the docs from `tracing-core`. :/ - Enabled unstable features in the documentation on docs.rs and netlify.
19 lines
343 B
TOML
19 lines
343 B
TOML
[build]
|
|
command = """
|
|
rustup install nightly --profile minimal \
|
|
&& cargo doc --no-deps --all-features
|
|
"""
|
|
publish = "target/doc"
|
|
|
|
[build.environment]
|
|
RUSTDOCFLAGS="""
|
|
-D warnings \
|
|
--cfg docsrs \
|
|
--cfg tracing_unstable
|
|
"""
|
|
RUSTFLAGS="--cfg tracing_unstable"
|
|
|
|
[[redirects]]
|
|
from = "/"
|
|
to = "/tracing"
|