Merge pull request #304 from CosmicHorrorDev/feature-doc-labels

Add in-doc labels for public facing features

Author: kivikakk

Cargo.toml

@@ -21,6 +21,10 @@ exclude = [
 resolver = "2"
 edition = "2018"
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [profile.release]
 lto = true
 

src/lib.rs

@@ -59,6 +59,7 @@
 //! # }
 //! ```
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![deny(
     missing_docs,
     missing_debug_implementations,

src/parser/mod.rs

@@ -329,8 +329,8 @@ pub struct ComrakExtensionOptions {
     pub front_matter_delimiter: Option<String>,
 
     #[cfg(feature = "shortcodes")]
-    /// Available if "shortcodes" feature is enabled.  Phrases wrapped inside of ':' blocks will be
-    /// replaced with emojis.
+    #[cfg_attr(docsrs, doc(cfg(feature = "shortcodes")))]
+    /// Phrases wrapped inside of ':' blocks will be replaced with emojis.
     ///
     /// ```
     /// # use comrak::{markdown_to_html, ComrakOptions};

src/plugins/mod.rs

@@ -1,4 +1,5 @@
 //! Plugins for enhancing the default implementation of comrak can be defined in this module.
 
 #[cfg(feature = "syntect")]
+#[cfg_attr(docsrs, doc(cfg(feature = "syntect")))]
 pub mod syntect;