Skip to content
This repository was archived by the owner on Nov 13, 2023. It is now read-only.

Commit 0cf198b

Browse files
committed
Inline Crates and Hide Prelude in Docs
This makes it much easier to search through on docs.rs.
1 parent cd59da2 commit 0cf198b

File tree

3 files changed

+7
-0
lines changed

3 files changed

+7
-0
lines changed

crates/building_blocks_core/src/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ pub use point::{point_traits::*, Point2, Point2f, Point2i, Point3, Point3f, Poin
2121
pub use bytemuck;
2222
pub use num;
2323

24+
#[doc(hidden)]
2425
pub mod prelude {
2526
pub use super::{
2627
point::point_traits::*, Axis2, Axis3, Bounded, ConstZero, Distance, DotProduct, Extent2,

crates/building_blocks_storage/src/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ pub type SmallKeyHashMap<K, V> = ahash::AHashMap<K, V>;
6868
pub type SmallKeyHashSet<K> = ahash::AHashSet<K>;
6969
pub type SmallKeyBuildHasher = ahash::RandomState;
7070

71+
#[doc(hidden)]
7172
pub mod prelude {
7273
pub use super::{
7374
copy_extent, Chunk, ChunkKey, ChunkKey2, ChunkKey3, ChunkMapBuilder, ChunkReadStorage,

src/lib.rs

+5
Original file line numberDiff line numberDiff line change
@@ -167,24 +167,29 @@
167167
168168
// TODO: when cargo-readme supports intra-doc links, replace URLs above
169169

170+
#[doc(inline)]
170171
pub mod core {
171172
pub use building_blocks_core::*;
172173
}
173174

175+
#[doc(inline)]
174176
pub mod storage {
175177
pub use building_blocks_storage::*;
176178
}
177179

180+
#[doc(inline)]
178181
#[cfg(feature = "mesh")]
179182
pub mod mesh {
180183
pub use building_blocks_mesh::*;
181184
}
182185

186+
#[doc(inline)]
183187
#[cfg(feature = "search")]
184188
pub mod search {
185189
pub use building_blocks_search::*;
186190
}
187191

192+
#[doc(hidden)]
188193
pub mod prelude {
189194
pub use super::core::prelude::*;
190195
pub use super::storage::prelude::*;

0 commit comments

Comments
 (0)