chore: add tracing logo to RustDoc (#832)

Now that the new https://tokio.rs is live, we can add the new Tracing logo to the RustDoc! I also added a couple missing `html_root_url` attributes in published crates. Signed-off-by: Eliza Weisman <eliza@buoyant.io>
tokio-rs · Jul 21, 2020 · add986d · add986d
1 parent b185d10
commit add986d
Show file tree

Hide file tree

Showing 14 changed files with 60 additions and 1 deletion.
diff --git a/assets/logo.svg b/assets/logo.svg
diff --git a/tracing-appender/src/lib.rs b/tracing-appender/src/lib.rs
@@ -105,6 +105,10 @@
 //! # }
 //! ```
 #![doc(html_root_url = "https://docs.rs/tracing-appender/0.1.1")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     missing_docs,

diff --git a/tracing-attributes/src/lib.rs b/tracing-attributes/src/lib.rs
@@ -36,6 +36,10 @@
 //! [span]: https://docs.rs/tracing/latest/tracing/span/index.html
 //! [instrument]: attr.instrument.html
 #![doc(html_root_url = "https://docs.rs/tracing-attributes/0.1.9")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     missing_docs,

diff --git a/tracing-core/src/lib.rs b/tracing-core/src/lib.rs
@@ -69,6 +69,10 @@
 //! [`tokio-rs/tracing`]: https://github.com/tokio-rs/tracing
 //! [`tracing`]: https://crates.io/crates/tracing
 #![doc(html_root_url = "https://docs.rs/tracing-core/0.1.11")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![cfg_attr(not(feature = "std"), no_std)]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![warn(

diff --git a/tracing-error/src/lib.rs b/tracing-error/src/lib.rs
@@ -170,6 +170,10 @@
 //! [`std::error::Error`]: https://doc.rust-lang.org/stable/std/error/trait.Error.html
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![doc(html_root_url = "https://docs.rs/tracing-error/0.1.2")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     missing_docs,

diff --git a/tracing-flame/src/lib.rs b/tracing-flame/src/lib.rs
@@ -91,6 +91,10 @@
 //! [`FlameLayer`]: struct.FlameLayer.html
 //! [`FlushGuard`]: struct.FlushGuard.html
 //! [`inferno-flamegraph`]: https://docs.rs/inferno/0.9.5/inferno/index.html#producing-a-flame-graph
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     missing_docs,

diff --git a/tracing-futures/src/lib.rs b/tracing-futures/src/lib.rs
@@ -54,7 +54,11 @@
 //! [`Instrument`]: trait.Instrument.html
 //! [`WithSubscriber`]: trait.WithSubscriber.html
 //! [`futures`]: https://crates.io/crates/futures
-#![doc(html_root_url = "https://docs.rs/tracing-futures/0.2.3")]
+#![doc(html_root_url = "https://docs.rs/tracing-futures/0.2.4")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     missing_docs,

diff --git a/tracing-journald/src/lib.rs b/tracing-journald/src/lib.rs
@@ -1,3 +1,7 @@
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #[cfg(unix)]
 use std::os::unix::net::UnixDatagram;
 use std::{fmt, io, io::Write};

diff --git a/tracing-log/src/lib.rs b/tracing-log/src/lib.rs
@@ -88,6 +88,10 @@
 //! [`tracing::Event`]: https://docs.rs/tracing/latest/tracing/struct.Event.html
 //! [flags]: https://docs.rs/tracing/latest/tracing/#crate-feature-flags
 #![doc(html_root_url = "https://docs.rs/tracing-log/0.1.1")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![warn(
     missing_debug_implementations,

diff --git a/tracing-opentelemetry/src/lib.rs b/tracing-opentelemetry/src/lib.rs
@@ -46,6 +46,11 @@
 //! ```
 #![deny(unreachable_pub)]
 #![cfg_attr(test, deny(warnings))]
+#![doc(html_root_url = "https://docs.rs/tracing-opentelemetry/0.5.0")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 
 /// Implementation of the trace::Layer as a source of OpenTelemetry data.
 mod layer;

diff --git a/tracing-serde/src/lib.rs b/tracing-serde/src/lib.rs
@@ -1,3 +1,8 @@
+#![doc(html_root_url = "https://docs.rs/tracing-serde/0.1.1")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     // missing_docs, // TODO: add documentation

diff --git a/tracing-subscriber/src/lib.rs b/tracing-subscriber/src/lib.rs
@@ -50,6 +50,10 @@
 //! [`parking_lot`]: https://crates.io/crates/parking_lot
 //! [`registry`]: registry/index.html
 #![doc(html_root_url = "https://docs.rs/tracing-subscriber/0.2.8")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![warn(
     missing_debug_implementations,

diff --git a/tracing-tower/src/lib.rs b/tracing-tower/src/lib.rs
@@ -1,4 +1,8 @@
 #![cfg_attr(docsrs, feature(doc_cfg))]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     // missing_docs, // TODO: add documentation!

diff --git a/tracing/src/lib.rs b/tracing/src/lib.rs
@@ -795,6 +795,10 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![doc(html_root_url = "https://docs.rs/tracing/0.1.16")]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg",
+    issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
 #![warn(
     missing_debug_implementations,
     missing_docs,