docs(workspace): add favicon url for documented packages (#3478)

gear-tech · Nov 10, 2023 · d723d7c · d723d7c
1 parent b353d0f
commit d723d7c
Show file tree

Hide file tree

Showing 21 changed files with 38 additions and 0 deletions.
diff --git a/common/src/lib.rs b/common/src/lib.rs
@@ -17,6 +17,8 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 #[macro_use]
 extern crate gear_common_codegen;

diff --git a/core-errors/src/lib.rs b/core-errors/src/lib.rs
@@ -20,6 +20,8 @@
 
 #![no_std]
 #![warn(missing_docs)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 extern crate alloc;
 

diff --git a/core-processor/src/lib.rs b/core-processor/src/lib.rs
@@ -22,6 +22,7 @@
 #![warn(missing_docs)]
 #![cfg_attr(feature = "strict", deny(warnings))]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 extern crate alloc;
 

diff --git a/core/src/lib.rs b/core/src/lib.rs
@@ -24,6 +24,7 @@
 #![warn(missing_docs)]
 #![cfg_attr(feature = "strict", deny(warnings))]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 extern crate alloc;
 

diff --git a/galloc/src/lib.rs b/galloc/src/lib.rs
@@ -19,6 +19,7 @@
 #![no_std]
 #![cfg_attr(feature = "strict", deny(warnings))]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 // until https://github.com/alexcrichton/dlmalloc-rs/pull/26 is merged
 #[cfg(not(windows))]

diff --git a/gclient/src/lib.rs b/gclient/src/lib.rs
@@ -129,6 +129,7 @@
 #![warn(missing_docs)]
 #![cfg_attr(feature = "strict", deny(warnings))]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 mod api;
 mod utils;

diff --git a/gcore/src/lib.rs b/gcore/src/lib.rs
@@ -66,6 +66,7 @@
 #![warn(missing_docs)]
 #![cfg_attr(feature = "strict", deny(warnings))]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 #![doc(test(attr(deny(warnings), allow(unused_variables, unused_assignments))))]
 
 extern crate alloc;

diff --git a/gmeta/src/lib.rs b/gmeta/src/lib.rs
@@ -209,6 +209,7 @@
 #![no_std]
 #![warn(missing_docs)]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 extern crate alloc;
 

diff --git a/gsdk/src/lib.rs b/gsdk/src/lib.rs
@@ -16,6 +16,9 @@
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
+
 //! Gear api
 pub use crate::{
     api::Api,

diff --git a/gstd/src/lib.rs b/gstd/src/lib.rs
@@ -130,6 +130,7 @@
 #![cfg_attr(target_arch = "wasm32", feature(alloc_error_handler))]
 #![cfg_attr(feature = "strict", deny(warnings))]
 #![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 #![doc(test(attr(deny(warnings), allow(unused_variables, unused_assignments))))]
 
 extern crate alloc;

diff --git a/gtest/src/lib.rs b/gtest/src/lib.rs
@@ -311,6 +311,8 @@
 //! assert_eq!(prog.balance(), 1000);
 //! ```
 #![deny(missing_docs)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 mod error;
 mod log;

diff --git a/lazy-pages/src/lib.rs b/lazy-pages/src/lib.rs
@@ -27,6 +27,8 @@
 //! It's not necessary behavior, but more simple and safe.
 
 #![allow(clippy::items_after_test_module)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 use common::{LazyPagesExecutionContext, LazyPagesRuntimeContext};
 use gear_core::pages::{PageDynSize, PageNumber, PageSizeNo, WasmPage};

diff --git a/pallets/gas/src/lib.rs b/pallets/gas/src/lib.rs
@@ -123,6 +123,8 @@
 //! The Gear Gas Pallet doesn't depend on the `GenesisConfig`.
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 use common::{
     storage::{MapStorage, ValueStorage},

diff --git a/pallets/gear-messenger/src/lib.rs b/pallets/gear-messenger/src/lib.rs
@@ -133,6 +133,8 @@
 //! length overflow (see Gear Payment Pallet).
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 // Runtime mock for running tests.
 #[cfg(test)]

diff --git a/pallets/gear-program/src/lib.rs b/pallets/gear-program/src/lib.rs
@@ -128,6 +128,8 @@
 //! The Gear Program Pallet doesn't depend on the `GenesisConfig`.
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 use sp_std::{convert::TryInto, prelude::*};
 

diff --git a/pallets/gear-scheduler/src/lib.rs b/pallets/gear-scheduler/src/lib.rs
@@ -19,6 +19,8 @@
 //! # Gear Scheduler Pallet
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 // Runtime mock for running tests.
 #[cfg(test)]

diff --git a/pallets/gear/rpc/runtime-api/src/lib.rs b/pallets/gear/rpc/runtime-api/src/lib.rs
@@ -17,6 +17,8 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 pub use pallet_gear::{manager::HandleKind, GasInfo};
 use sp_core::H256;

diff --git a/pallets/gear/rpc/src/lib.rs b/pallets/gear/rpc/src/lib.rs
@@ -20,6 +20,8 @@
 
 #![allow(clippy::too_many_arguments)]
 #![allow(where_clauses_object_safety)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 use gear_common::Origin;
 use gear_core::ids::{CodeId, MessageId, ProgramId};

diff --git a/pallets/gear/src/lib.rs b/pallets/gear/src/lib.rs
@@ -18,6 +18,8 @@
 
 #![cfg_attr(not(feature = "std"), no_std)]
 #![cfg_attr(feature = "runtime-benchmarks", recursion_limit = "1024")]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 extern crate alloc;
 

diff --git a/pallets/payment/src/lib.rs b/pallets/payment/src/lib.rs
@@ -17,6 +17,8 @@
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
 
 use common::{storage::*, ExtractCall};
 use frame_support::{

diff --git a/utils/wasm-builder/src/lib.rs b/utils/wasm-builder/src/lib.rs
@@ -16,6 +16,10 @@
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
+#![cfg_attr(feature = "strict", deny(warnings))]
+#![doc(html_logo_url = "https://docs.gear.rs/logo.svg")]
+#![doc(html_favicon_url = "https://gear-tech.io/favicons/favicon.ico")]
+
 use crate::{cargo_command::CargoCommand, cargo_toolchain::Toolchain, wasm_project::WasmProject};
 use anyhow::{Context, Result};
 use gmeta::{Metadata, MetadataRepr};