From fe78005d4ec26cdfd33bdb78b06a1b411aa810ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?dj8yf0=CE=BCl?= <26653921+dj8yfo@users.noreply.github.com> Date: Mon, 13 Jan 2025 16:14:42 +0200 Subject: [PATCH] fix: cargo publish errors with reference to `docs/` folder (#331) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: dj8yf0μl --- README.md | 6 +++--- .../docs}/migration_guides/v0.10.2_to_v1.0.0_nearcore.md | 0 .../docs}/migration_guides/v0.9_to_v1.0.0_near_sdk_rs.md | 0 .../docs}/rustdoc_include/borsh_crate_top_level.md | 0 {docs => borsh/docs}/rustdoc_include/borsh_deserialize.md | 0 {docs => borsh/docs}/rustdoc_include/borsh_schema.md | 0 {docs => borsh/docs}/rustdoc_include/borsh_serialize.md | 0 borsh/src/lib.rs | 8 ++++---- 8 files changed, 7 insertions(+), 7 deletions(-) rename {docs => borsh/docs}/migration_guides/v0.10.2_to_v1.0.0_nearcore.md (100%) rename {docs => borsh/docs}/migration_guides/v0.9_to_v1.0.0_near_sdk_rs.md (100%) rename {docs => borsh/docs}/rustdoc_include/borsh_crate_top_level.md (100%) rename {docs => borsh/docs}/rustdoc_include/borsh_deserialize.md (100%) rename {docs => borsh/docs}/rustdoc_include/borsh_schema.md (100%) rename {docs => borsh/docs}/rustdoc_include/borsh_serialize.md (100%) diff --git a/README.md b/README.md index fdbb878a5..e8cfb78c0 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,9 @@ fn test_simple_struct() { Following pages are highlighted here just to give reader a chance at learning that they exist. -- [Derive Macro `BorshSerialize`](./docs/rustdoc_include/borsh_serialize.md) -- [Derive Macro `BorshDeserialize`](./docs/rustdoc_include/borsh_deserialize.md) -- [Derive Macro `BorshSchema`](./docs/rustdoc_include/borsh_schema.md) +- [Derive Macro `BorshSerialize`](./borsh/docs/rustdoc_include/borsh_serialize.md) +- [Derive Macro `BorshDeserialize`](./borsh/docs/rustdoc_include/borsh_deserialize.md) +- [Derive Macro `BorshSchema`](./borsh/docs/rustdoc_include/borsh_schema.md) ## Advanced examples diff --git a/docs/migration_guides/v0.10.2_to_v1.0.0_nearcore.md b/borsh/docs/migration_guides/v0.10.2_to_v1.0.0_nearcore.md similarity index 100% rename from docs/migration_guides/v0.10.2_to_v1.0.0_nearcore.md rename to borsh/docs/migration_guides/v0.10.2_to_v1.0.0_nearcore.md diff --git a/docs/migration_guides/v0.9_to_v1.0.0_near_sdk_rs.md b/borsh/docs/migration_guides/v0.9_to_v1.0.0_near_sdk_rs.md similarity index 100% rename from docs/migration_guides/v0.9_to_v1.0.0_near_sdk_rs.md rename to borsh/docs/migration_guides/v0.9_to_v1.0.0_near_sdk_rs.md diff --git a/docs/rustdoc_include/borsh_crate_top_level.md b/borsh/docs/rustdoc_include/borsh_crate_top_level.md similarity index 100% rename from docs/rustdoc_include/borsh_crate_top_level.md rename to borsh/docs/rustdoc_include/borsh_crate_top_level.md diff --git a/docs/rustdoc_include/borsh_deserialize.md b/borsh/docs/rustdoc_include/borsh_deserialize.md similarity index 100% rename from docs/rustdoc_include/borsh_deserialize.md rename to borsh/docs/rustdoc_include/borsh_deserialize.md diff --git a/docs/rustdoc_include/borsh_schema.md b/borsh/docs/rustdoc_include/borsh_schema.md similarity index 100% rename from docs/rustdoc_include/borsh_schema.md rename to borsh/docs/rustdoc_include/borsh_schema.md diff --git a/docs/rustdoc_include/borsh_serialize.md b/borsh/docs/rustdoc_include/borsh_serialize.md similarity index 100% rename from docs/rustdoc_include/borsh_serialize.md rename to borsh/docs/rustdoc_include/borsh_serialize.md diff --git a/borsh/src/lib.rs b/borsh/src/lib.rs index 71cab161e..ba4ce6501 100644 --- a/borsh/src/lib.rs +++ b/borsh/src/lib.rs @@ -1,18 +1,18 @@ #![cfg_attr(not(feature = "std"), no_std)] -#![doc = include_str!("../../docs/rustdoc_include/borsh_crate_top_level.md")] +#![doc = include_str!("../docs/rustdoc_include/borsh_crate_top_level.md")] #[cfg(not(feature = "std"))] extern crate alloc; -#[doc = include_str!("../../docs/rustdoc_include/borsh_schema.md")] +#[doc = include_str!("../docs/rustdoc_include/borsh_schema.md")] #[cfg(feature = "unstable__schema")] pub use borsh_derive::BorshSchema; -#[doc = include_str!("../../docs/rustdoc_include/borsh_deserialize.md")] +#[doc = include_str!("../docs/rustdoc_include/borsh_deserialize.md")] #[cfg(feature = "derive")] pub use borsh_derive::BorshDeserialize; -#[doc = include_str!("../../docs/rustdoc_include/borsh_serialize.md")] +#[doc = include_str!("../docs/rustdoc_include/borsh_serialize.md")] #[cfg(feature = "derive")] pub use borsh_derive::BorshSerialize;