docs/
lib.rs

1//!
2// Important: note the blank line of documentation on each side of the image lookup table.
3// The "image lookup table" can be placed anywhere, but we place it here together with the
4// warning if the `doc-images` feature is not enabled.
5#![cfg_attr(feature = "doc-images",
6cfg_attr(all(),
7doc = ::embed_doc_image::embed_image!("arch", "figures/arch.png"),
8doc = ::embed_doc_image::embed_image!("digraph_frostycry", "figures/digraph_frostycry.png"),
9doc = ::embed_doc_image::embed_image!("digraph_frostycry_drawio", "figures/digraph_frostycry_drawio.png"),
10doc = ::embed_doc_image::embed_image!("triton_cfg_colour", "figures/triton_cfg_colour.png"),
11doc = ::embed_doc_image::embed_image!("modes", "figures/modes.png"),
12    ))]
13#![cfg_attr(
14    not(feature = "doc-images"),
15    doc = "**Doc images not enabled**. Compile with feature `doc-images` and Rust version >= 1.54 \
16           to enable."
17)]
18//!
19//!
20#![doc = include_str!("../pages/index.md")]
21
22pub mod getting_started {
23    #![doc = include_str!("../pages/getting_started.md")]
24}
25
26pub mod modes {
27    //!
28    #![cfg_attr(feature = "doc-images",
29cfg_attr(all(),
30doc = ::embed_doc_image::embed_image!("modes", "figures/modes.png"),
31    ))]
32    #![cfg_attr(
33        not(feature = "doc-images"),
34        doc = "**Doc images not enabled**. Compile with feature `doc-images` and Rust version >= 1.54 \
35           to enable."
36    )]
37    //!
38    #![doc = include_str!("../pages/modes.md")]
39}
40
41pub mod developer_docs {
42    #![doc = include_str!("../pages/developer_docs.md")]
43}
44
45pub mod research_paper {
46    #![doc = include_str!("../pages/research_paper.md")]
47}
docs/lib.rs

docs/
lib.rs
