meta: Add favicon to rustdoc and downgrade missing_docs warning (#242)

getsentry · Aug 19, 2020 · 0d9d1d0 · 0d9d1d0
1 parent 37c3bdf
commit 0d9d1d0
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 13 deletions.
diff --git a/sentry-actix/src/lib.rs b/sentry-actix/src/lib.rs
@@ -63,8 +63,9 @@
 //! # }
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![allow(clippy::needless_doctest_main)]
 
 use std::borrow::Cow;

diff --git a/sentry-anyhow/src/lib.rs b/sentry-anyhow/src/lib.rs
@@ -16,8 +16,9 @@
 //! # Ok(()) }
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![deny(unsafe_code)]
 
 use std::error::Error;

diff --git a/sentry-backtrace/src/lib.rs b/sentry-backtrace/src/lib.rs
@@ -3,8 +3,9 @@
 //! Exposes functions to capture, process and convert/parse stacktraces, as well
 //! as integrations to process event stacktraces.
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 
 mod integration;
 mod parse;

diff --git a/sentry-contexts/src/lib.rs b/sentry-contexts/src/lib.rs
@@ -18,8 +18,9 @@
 //!
 //! [Contexts Interface]: https://develop.sentry.dev/sdk/event-payloads/contexts/
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 
 mod integration;
 mod utils;

diff --git a/sentry-core/src/lib.rs b/sentry-core/src/lib.rs
@@ -43,9 +43,11 @@
 //! [`Integration`]: trait.Integration.html
 //! [`Transport`]: trait.Transport.html
 //! [`TransportFactory`]: trait.TransportFactory.html
+//! [`test`]: test/index.html
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 
 // macros; these need to be first to be used by other modules
 #[macro_use]

diff --git a/sentry-debug-images/src/lib.rs b/sentry-debug-images/src/lib.rs
@@ -16,8 +16,9 @@
 //! };
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![deny(unsafe_code)]
 
 #[cfg(unix)]

diff --git a/sentry-error-chain/src/lib.rs b/sentry-error-chain/src/lib.rs
@@ -23,8 +23,9 @@
 //! # Ok(()) }
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![deny(unsafe_code)]
 
 use std::fmt::{Debug, Display};

diff --git a/sentry-failure/src/lib.rs b/sentry-failure/src/lib.rs
@@ -24,8 +24,9 @@
 //!
 //! To capture fails and not errors use `capture_fail`.
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![deny(unsafe_code)]
 #![warn(missing_doc_code_examples)]
 

diff --git a/sentry-log/src/lib.rs b/sentry-log/src/lib.rs
@@ -26,8 +26,9 @@
 //! log::error!("Generates an event");
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 
 mod converters;
 mod integration;

diff --git a/sentry-panic/src/lib.rs b/sentry-panic/src/lib.rs
@@ -14,8 +14,9 @@
 //! let integration = sentry_panic::PanicIntegration::default().add_extractor(|info| None);
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![deny(unsafe_code)]
 #![warn(missing_doc_code_examples)]
 

diff --git a/sentry-slog/src/lib.rs b/sentry-slog/src/lib.rs
@@ -64,8 +64,9 @@
 //! [`SlogIntegration`]: struct.SlogIntegration.html
 //! [`SentryDrain`]: struct.SentryDrain.html
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 #![deny(unsafe_code)]
 
 mod converters;

diff --git a/sentry-types/src/lib.rs b/sentry-types/src/lib.rs
@@ -32,8 +32,9 @@
 //! };
 //! ```
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 
 #[macro_use]
 mod macros;

diff --git a/sentry/src/lib.rs b/sentry/src/lib.rs
@@ -72,8 +72,9 @@
 //!   Please note that `native-tls` is a default feature, and one needs to use
 //!   `default-features = false` to completely disable building `native-tls` dependencies.
 
+#![doc(html_favicon_url = "https://sentry-brand.storage.googleapis.com/favicon.ico")]
 #![doc(html_logo_url = "https://sentry-brand.storage.googleapis.com/sentry-glyph-black.png")]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
 
 mod defaults;
 mod init;