1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
//! Showcase for `embed-doc-image`. //! // Important: note the blank line of documentation on each side of the image lookup table. // The "image lookup table" can be placed anywhere, but we place it here together with the // warning if the `doc-images` feature is not enabled. #![cfg_attr(feature = "doc-images", cfg_attr(all(), doc = ::embed_doc_image::embed_image!("ferris", "images/rustacean-orig-noshadow-tiny.png"), doc = ::embed_doc_image::embed_image!("ferris-gesture", "images/rustacean-flat-gesture-tiny.png"), doc = ::embed_doc_image::embed_image!("dancing-ferris", "images/dancing-ferris-tiny.gif"), doc = ::embed_doc_image::embed_image!("corro", "images/corro.svg")))] #![cfg_attr( not(feature = "doc-images"), doc = "**Doc images not enabled**. Compile with feature `doc-images` and Rust version >= 1.54 \ to enable." )] //! //! This crate contains no functionality, it is merely a demonstration of how to use //! [embed-doc-image](https://crates.io/crates/embed-doc-image) to embed images local to the //! repository that work across both [docs.rs](https://docs.rs) and //! local documentation. The motivation for this crate is //! [rustdoc's inability to include local images](https://github.com/rust-lang/rust/issues/32104) //! in a way that consistently works across local copies of the repository and `docs.rs`. //! //! See [the documentation](https://docs.rs/embed-doc-image) for more information. //! In addition, you are encouraged to browse the source code for this showcase crate to see a //! fleshed out example of how the solution works. //! //! In addition to serving as a showcase, this crate is used to verify that the solution indeed //! works across both local installations and `docs.rs`. //! This is necessary because a proc macro crate cannot use its own macros in its own documentation. //! //! `embed-doc-image` should work across the usual web-supported file types //! (jpg, png, svg, gif, bmp). If you find that it does not work with your files, please //! file an issue. //! //! The below Ferris images are courtesy of [rustacean.net](https://rustacean.net). //! //! ![Original Ferris][ferris] //! //! ![Ferris making gesture][ferris-gesture] //! //! ![Corro][corro] //! //! ![Dancing Ferris][dancing-ferris] //! use embed_doc_image::embed_doc_image; /// Test that images render in function docs. /// /// ![Original Ferris][ferris] ![Ferris makes gesture][ferris-gesture] /// /// Some more docs. /// /// ![Corro][corro] ![Dancing Ferris][dancing-ferris] #[embed_doc_image("ferris", "images/rustacean-orig-noshadow-tiny.png")] #[embed_doc_image("ferris-gesture", "images/rustacean-flat-gesture-tiny.png")] #[embed_doc_image("dancing-ferris", "images/dancing-ferris-tiny.gif")] #[embed_doc_image("corro", "images/corro.svg")] pub fn function_docs_work() {} /// Test that images render in module docs. /// /// ![Original Ferris][ferris] ![Ferris makes gesture][ferris-gesture] /// /// Some more docs. /// /// ![Corro][corro] ![Dancing Ferris][dancing-ferris] #[embed_doc_image("ferris", "images/rustacean-orig-noshadow-tiny.png")] #[embed_doc_image("ferris-gesture", "images/rustacean-flat-gesture-tiny.png")] #[embed_doc_image("dancing-ferris", "images/dancing-ferris-tiny.gif")] #[embed_doc_image("corro", "images/corro.svg")] pub mod module_docs_work {} /// Test that images render in macro docs. /// /// ![Original Ferris][ferris] ![Ferris makes gesture][ferris-gesture] /// /// Some more docs. /// /// ![Corro][corro] ![Dancing Ferris][dancing-ferris] #[embed_doc_image("ferris", "images/rustacean-orig-noshadow-tiny.png")] #[embed_doc_image("ferris-gesture", "images/rustacean-flat-gesture-tiny.png")] #[embed_doc_image("dancing-ferris", "images/dancing-ferris-tiny.gif")] #[embed_doc_image("corro", "images/corro.svg")] #[macro_export] macro_rules! macro_docs_work { () => {}; } /// Test that images render in struct docs. /// /// ![Original Ferris][ferris] ![Ferris makes gesture][ferris-gesture] /// /// Some more docs. /// /// ![Corro][corro] ![Dancing Ferris][dancing-ferris] #[embed_doc_image("ferris", "images/rustacean-orig-noshadow-tiny.png")] #[embed_doc_image("ferris-gesture", "images/rustacean-flat-gesture-tiny.png")] #[embed_doc_image("dancing-ferris", "images/dancing-ferris-tiny.gif")] #[embed_doc_image("corro", "images/corro.svg")] pub struct StructDocsWork {} /// Test that images render in trait docs. /// /// ![Original Ferris][ferris] ![Ferris makes gesture][ferris-gesture] /// /// Some more docs. /// /// ![Corro][corro] ![Dancing Ferris][dancing-ferris] #[embed_doc_image("ferris", "images/rustacean-orig-noshadow-tiny.png")] #[embed_doc_image("ferris-gesture", "images/rustacean-flat-gesture-tiny.png")] #[embed_doc_image("dancing-ferris", "images/dancing-ferris-tiny.gif")] #[embed_doc_image("corro", "images/corro.svg")] pub trait TraitDocsWork {} /// Test that images render in type docs. /// /// ![Original Ferris][ferris] ![Ferris makes gesture][ferris-gesture] /// /// Some more docs. /// /// ![Corro][corro] ![Dancing Ferris][dancing-ferris] #[embed_doc_image("ferris", "images/rustacean-orig-noshadow-tiny.png")] #[embed_doc_image("ferris-gesture", "images/rustacean-flat-gesture-tiny.png")] #[embed_doc_image("dancing-ferris", "images/dancing-ferris-tiny.gif")] #[embed_doc_image("corro", "images/corro.svg")] pub type TypeAliasDocsWork = f64;