include-doc 0.0.1

Include examples in your Rustdocs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# include Doc

[![tests](https://github.com/simon-bourne/include-doc/actions/workflows/tests.yml/badge.svg)](https://github.com/simon-bourne/include-doc/actions/workflows/tests.yml)
[![crates.io](https://img.shields.io/crates/v/include-doc.svg)](https://crates.io/crates/include-doc)
[![Documentation](https://docs.rs/include-doc/badge.svg)](https://docs.rs/include-doc)
[![MIT/Apache-2 licensed](https://img.shields.io/crates/l/include-doc)](./LICENSE-APACHE)

Include examples in your Rustdocs.

This crate allows you to include example files in Rustdoc.

## Features

- Write and maintain your examples in a normal Rust file, with full editor support. See [this example](example/src/doc_with_example.rs).
- Automatically hide imports.
- Put many examples into one file, avoiding duplicated boilerplate for setup code. ee [this example](example/src/doc_with_tests.rs).