Merge pull request #354 from DaniPopes/fix-uint-docs

Cargo.toml

@@ -4,7 +4,7 @@ description = "Unsigned integer type with const-generic bit length"
 version = "1.12.0"
 keywords = ["uint"]
 categories = ["mathematics"]
-include = ["src/**/*.rs", "README.md", "ruint-macro/README.md"]
+include = ["src/**/*.rs", "README.md"]
 readme = "README.md"
 
 edition.workspace = true

src/lib.rs

@@ -73,6 +73,12 @@ pub use self::{
     string::ParseError,
 };
 
+// For documentation purposes we expose the macro directly, otherwise it is
+// wrapped in ./macros.rs.
+#[cfg(doc)]
+#[doc(inline)]
+pub use ruint_macro::uint;
+
 #[cfg(feature = "generic_const_exprs")]
 pub mod nightly {
     //! Extra features that are nightly only.

src/macros.rs

@@ -1,6 +1,7 @@
-#[allow(rustdoc::broken_intra_doc_links)]
-#[doc = include_str!("../ruint-macro/README.md")]
+/// Wrapper for [`ruint_macro::uint!`]. See its documentation for details.
 #[macro_export]
+#[cfg(not(doc))] // Show the actual macro in docs.
+#[doc(hidden)]
 macro_rules! uint {
     ($($t:tt)*) => {
         $crate::__private::ruint_macro::uint_with_path!([$crate] $($t)*)