docify_clone 0.0.5

Docify allows you to live-embed at compile time pieces of code from throughout your project as rust doc examples.
Documentation 
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

/// These are some docs
/// These are some more docs
#[doc = docify_clone::embed!("examples/samples.rs", MyCoolStruct)]
/// even more here
#[allow(unused)]
pub struct SomeItem;

/// These are some docs
/// These are some more docs
#[doc = docify_clone::embed!("examples/samples.rs", SomeImpl)]
/// even more here
#[allow(unused)]
pub struct TestExplicitName;

/// Some more docs
#[doc = docify_clone::embed!("examples/samples.rs", some_random_test)]
#[doc = docify_clone::embed!("examples/samples.rs", test_with_custom_name)]
pub struct MultipleEmbeds;

#[doc = docify_clone::embed!("examples/samples.rs", Duplicate)]
pub struct Duplicates;

/// This example will actually run in rust docs
#[doc = docify::embed_run!("examples/samples.rs", runnable)]
pub struct Runnable;

/// This example runs a test
#[doc = docify::embed_run!("examples/samples.rs", test_with_custom_name)]
pub struct RunnableTest;

/// This example has comments
#[doc = docify_clone::embed!("examples/samples.rs", some_complex_example)]
pub struct LineComments;

/// This example has wonky formatting that would normally get auto-correct by rustfmt but that
/// has been manually allowed using a flag
#[doc = docify_clone::embed!("examples/samples.rs", wonky_comment_example)]
pub struct WonkyComments;

/// This example caused an error regression
#[doc = docify_clone::embed!("macros/fixtures/complicated.rs", successful_unstake)]
pub struct KianRegression;

/// This has always worked
#[doc = docify_clone::embed!("examples/samples.rs", test_with_normal_ordering)]
pub struct TestWithNormalOrdering;

/// This example originally failed with <https://github.com/sam0x17/docify/issues/1>
#[doc = docify_clone::embed!("examples/samples.rs", test_with_weird_ordering)]
pub struct TestWithWeirdOrdering;

/// This example has docify-related export keywords directly in the doc comments. They should
/// not get stripped:
#[doc = docify_clone::embed!("examples/samples.rs", docify_keyword_in_comments)]
pub struct TestWithWeirdOrderingAndKeywords;

/// This example pertains to <https://github.com/sam0x17/docify/issues/2>
#[doc = docify_clone::embed!("examples/samples.rs", oliver_substrate_example_2)]
pub struct OliverExample2;

/// This example is from Liam
#[doc = docify_clone::embed!("examples/samples.rs", LiamIssue7)]
pub struct LiamExample;

/// This is Liam's issue #9
#[doc = docify_clone::embed!("examples/samples.rs", trait_impl_method)]
pub struct LiamExample9;

/// This demonstrates using `#[docify_clone::export_content]` on an impl
#[doc = docify_clone::embed!("examples/samples.rs", impl_some_other_trait_for_my_cool_struct)]
pub struct ExportContentImpl;

/// This demonstrates using `#[docify_clone::export_content]` on a trait
#[doc = docify::embed_run!("examples/samples.rs", SomeOtherTrait)]
pub struct ExportContentTrait;

/// This demonstrates using `#[docify_clone::export_content]` on an fn
#[doc = docify_clone::embed!("examples/samples.rs", some_other_fn)]
pub struct ExportContentFn;

/// This demonstrates using `#[docify_clone::export_content]` on a const, which should be identical
/// to using `#[docify_clone::export]` on a const since const has no notion of content.
#[doc = docify_clone::embed!("examples/samples.rs", MY_CONST)]
pub struct ExportContentConst;

/// This tests that `#[docify_clone::export]` can appear inside of things that have
/// `#[docify_clone::export]` on them.
#[doc = docify_clone::embed!("examples/samples.rs", outer_mod)]
#[doc = docify_clone::embed!("examples/samples.rs", outer_foo)]
#[doc = docify_clone::embed!("examples/samples.rs", inner_mod)]
#[doc = docify_clone::embed!("examples/samples.rs", inner_inner_bar)]
#[doc = docify_clone::embed!("examples/samples.rs", inner_mod2)]
pub struct NestedExports;

/// This will compile all markdown files in the `markdown_source` directory to `markdown_bin`
/// when `cargo doc` is run, handling any doc embed calls as it goes
#[cfg(doc)]
docify::compile_markdown!("examples/markdown_source", "examples/markdown_bin");

fn main() {}