From 1bf4157a89a126f095bedf5a16ef737ba1bef5cb Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Mon, 5 Apr 2021 11:42:04 +0200 Subject: [PATCH] Add favicon and logo URLs for rustdoc --- ruma-api-macros/src/lib.rs | 2 ++ ruma-api/src/lib.rs | 2 ++ ruma-appservice-api/src/lib.rs | 2 ++ ruma-client-api/src/lib.rs | 2 ++ ruma-client/src/lib.rs | 2 ++ ruma-common/src/lib.rs | 2 ++ ruma-events-macros/src/lib.rs | 2 ++ ruma-events/src/lib.rs | 2 ++ ruma-federation-api/src/lib.rs | 2 ++ ruma-identifiers-macros/src/lib.rs | 3 +++ ruma-identifiers-validation/src/lib.rs | 3 +++ ruma-identifiers/src/lib.rs | 2 ++ ruma-identity-service-api/src/lib.rs | 3 +++ ruma-push-gateway-api/src/lib.rs | 2 ++ ruma-serde-macros/src/lib.rs | 3 +++ ruma-serde/src/lib.rs | 2 ++ ruma-signatures/src/lib.rs | 2 ++ ruma/src/lib.rs | 2 ++ 18 files changed, 40 insertions(+) diff --git a/ruma-api-macros/src/lib.rs b/ruma-api-macros/src/lib.rs index 8158136f..dec98679 100644 --- a/ruma-api-macros/src/lib.rs +++ b/ruma-api-macros/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate ruma-api-macros provides a procedural macro for easily generating //! [ruma-api]-compatible endpoints. //! diff --git a/ruma-api/src/lib.rs b/ruma-api/src/lib.rs index 64d7f5e7..afcef42d 100644 --- a/ruma-api/src/lib.rs +++ b/ruma-api/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate `ruma_api` contains core types used to define the requests and responses for each endpoint //! in the various [Matrix](https://matrix.org) API specifications. //! These types can be shared by client and server code for all Matrix APIs. diff --git a/ruma-appservice-api/src/lib.rs b/ruma-appservice-api/src/lib.rs index 5aea2dcc..fb262c6e 100644 --- a/ruma-appservice-api/src/lib.rs +++ b/ruma-appservice-api/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate ruma_appservice_api contains serializable types for the requests and responses for each //! endpoint in the [Matrix](https://matrix.org/) application service API specification. These //! types can be shared by application service and server code. diff --git a/ruma-client-api/src/lib.rs b/ruma-client-api/src/lib.rs index a1327351..7f8da227 100644 --- a/ruma-client-api/src/lib.rs +++ b/ruma-client-api/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate ruma_client_api contains serializable types for the requests and responses for each //! endpoint in the [Matrix](https://matrix.org/) client API specification. These types can be //! shared by client and server code. diff --git a/ruma-client/src/lib.rs b/ruma-client/src/lib.rs index 56241f74..b185eebc 100644 --- a/ruma-client/src/lib.rs +++ b/ruma-client/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate `ruma_client` is a [Matrix](https://matrix.org/) client library. //! //! # Usage diff --git a/ruma-common/src/lib.rs b/ruma-common/src/lib.rs index fbfe69df..b04a6625 100644 --- a/ruma-common/src/lib.rs +++ b/ruma-common/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Common types for other ruma crates. #![warn(missing_docs, missing_debug_implementations)] diff --git a/ruma-events-macros/src/lib.rs b/ruma-events-macros/src/lib.rs index 19a01486..055722eb 100644 --- a/ruma-events-macros/src/lib.rs +++ b/ruma-events-macros/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate `ruma_events_macros` provides a procedural macro for generating //! [ruma-events] events. //! diff --git a/ruma-events/src/lib.rs b/ruma-events/src/lib.rs index c614514e..5e12c05d 100644 --- a/ruma-events/src/lib.rs +++ b/ruma-events/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate `ruma_events` contains serializable types for the events in the //! [Matrix](https://matrix.org) specification that can be shared by client and server code. //! diff --git a/ruma-federation-api/src/lib.rs b/ruma-federation-api/src/lib.rs index b726dd82..abec7248 100644 --- a/ruma-federation-api/src/lib.rs +++ b/ruma-federation-api/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! (De)serializable types for the Matrix Federation API. #![warn(missing_docs)] diff --git a/ruma-identifiers-macros/src/lib.rs b/ruma-identifiers-macros/src/lib.rs index 9b9faac4..4b6f2c51 100644 --- a/ruma-identifiers-macros/src/lib.rs +++ b/ruma-identifiers-macros/src/lib.rs @@ -1,3 +1,6 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] + use proc_macro::TokenStream; use quote::quote; diff --git a/ruma-identifiers-validation/src/lib.rs b/ruma-identifiers-validation/src/lib.rs index f6755179..81350f8f 100644 --- a/ruma-identifiers-validation/src/lib.rs +++ b/ruma-identifiers-validation/src/lib.rs @@ -1,3 +1,6 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] + pub mod device_key_id; pub mod error; pub mod event_id; diff --git a/ruma-identifiers/src/lib.rs b/ruma-identifiers/src/lib.rs index b9279be4..1fe3f5f8 100644 --- a/ruma-identifiers/src/lib.rs +++ b/ruma-identifiers/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate **ruma_identifiers** contains types for [Matrix](https://matrix.org/) identifiers //! for events, rooms, room aliases, room versions, and users. diff --git a/ruma-identity-service-api/src/lib.rs b/ruma-identity-service-api/src/lib.rs index b5d734c4..7940af2c 100644 --- a/ruma-identity-service-api/src/lib.rs +++ b/ruma-identity-service-api/src/lib.rs @@ -1,3 +1,6 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] + pub mod authentication; pub mod keys; pub mod status; diff --git a/ruma-push-gateway-api/src/lib.rs b/ruma-push-gateway-api/src/lib.rs index 3760613e..5e7d2cdf 100644 --- a/ruma-push-gateway-api/src/lib.rs +++ b/ruma-push-gateway-api/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! (De)serializable types for the Matrix Push Gateway API. #![warn(missing_docs)] diff --git a/ruma-serde-macros/src/lib.rs b/ruma-serde-macros/src/lib.rs index 06bd8ab5..0d60b5a6 100644 --- a/ruma-serde-macros/src/lib.rs +++ b/ruma-serde-macros/src/lib.rs @@ -1,3 +1,6 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] + use proc_macro::TokenStream; use quote::quote; use syn::{parse_macro_input, DeriveInput, ItemEnum}; diff --git a/ruma-serde/src/lib.rs b/ruma-serde/src/lib.rs index e9a3ccc5..4f1ad30c 100644 --- a/ruma-serde/src/lib.rs +++ b/ruma-serde/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! De-/serialization helpers for other ruma crates pub mod can_be_empty; diff --git a/ruma-signatures/src/lib.rs b/ruma-signatures/src/lib.rs index b09913e0..20ed065f 100644 --- a/ruma-signatures/src/lib.rs +++ b/ruma-signatures/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Crate `ruma_signatures` implements digital signatures according to the //! [Matrix](https://matrix.org/) specification. //! diff --git a/ruma/src/lib.rs b/ruma/src/lib.rs index 66c110e8..8afcf3e4 100644 --- a/ruma/src/lib.rs +++ b/ruma/src/lib.rs @@ -1,3 +1,5 @@ +#![doc(html_favicon_url = "https://www.ruma.io/favicon.ico")] +#![doc(html_logo_url = "https://www.ruma.io/images/logo.png")] //! Types and traits for working with the Matrix protocol. //! //! This crate re-exports things from all of the other ruma crates so you don't