diff options
| -rw-r--r-- | mingling/src/docs/docsrs_examples.md | 5 | ||||
| -rw-r--r-- | mingling/src/lib.rs | 2 |
2 files changed, 6 insertions, 1 deletions
diff --git a/mingling/src/docs/docsrs_examples.md b/mingling/src/docs/docsrs_examples.md new file mode 100644 index 0000000..34f3af9 --- /dev/null +++ b/mingling/src/docs/docsrs_examples.md @@ -0,0 +1,5 @@ +Example projects for `Mingling`, for learning how to use `Mingling` + +**NOTE:** + +This module is only enabled under the [`docs_rs`](./../feature/constant.MINGLING_DOCS_RS.html) feature, and serves as the `EXAMPLES` page under [docs.rs](https://docs.rs/mingling/latest/mingling/). diff --git a/mingling/src/lib.rs b/mingling/src/lib.rs index 7dbd018..7363a6d 100644 --- a/mingling/src/lib.rs +++ b/mingling/src/lib.rs @@ -172,7 +172,7 @@ pub use mingling_macros::Grouped; #[cfg(feature = "structural_renderer")] pub use mingling_macros::StructuralData; -/// Example projects for `Mingling`, for learning how to use `Mingling` +#[doc = include_str!("docs/docsrs_examples.md")] #[cfg(all(feature = "core", feature = "docs_rs"))] #[allow(nonstandard_style)] pub mod EXAMPLES { |