Skip to content

Commit

Permalink
Add doc_cfg (#64)
Browse files Browse the repository at this point in the history
Document which cargo features are needed in order for certain API
features to be available.
  • Loading branch information
tarcieri committed Mar 27, 2021
1 parent 29900f9 commit 5d67fa1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ vector = ["generic-array"]

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
18 changes: 14 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
//! [Variance]: https://docs.rs/micromath/latest/micromath/statistics/trait.Variance.html

#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/tarcieri/micromath/main/img/micromath-sq.png",
html_root_url = "https://docs.rs/micromath/1.1.0"
Expand All @@ -91,18 +92,27 @@
unused_qualifications
)]

mod f32ext;
#[cfg(feature = "quaternion")]
#[cfg_attr(docsrs, doc(cfg(feature = "quaternion")))]
pub mod quaternion;

#[cfg(feature = "statistics")]
#[cfg_attr(docsrs, doc(cfg(feature = "statistics")))]
pub mod statistics;

#[cfg(feature = "vector")]
#[cfg_attr(docsrs, doc(cfg(feature = "vector")))]
pub mod vector;

mod f32ext;

pub use crate::f32ext::F32Ext;

#[cfg(feature = "quaternion")]
pub use crate::quaternion::Quaternion;

#[cfg(feature = "vector")]
pub use crate::vector::{Vector, VectorExt};
#[cfg(feature = "vector")]
pub use generic_array;
pub use {
crate::vector::{Vector, VectorExt},
generic_array,
};

0 comments on commit 5d67fa1

Please sign in to comment.