Crate embed_doc_image_showcase

Showcase for embed-doc-image.

This crate contains no functionality, it is merely a demonstration of how to use embed-doc-image to embed images local to the repository that work across both docs.rs and local documentation. The motivation for this crate is rustdoc’s inability to include local images in a way that consistently works across local copies of the repository and docs.rs.

See the documentation 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.

Modules

module_docs_work

Test that images render in module docs.

Macros

macro_docs_work

Test that images render in macro docs.

Structs

StructDocsWork

Test that images render in struct docs.

Traits

TraitDocsWork

Test that images render in trait docs.

Functions

function_docs_work

Test that images render in function docs.

Type Definitions

TypeAliasDocsWork

Test that images render in type docs.