From 07a124765724bcd4c818efbfc8d4381d04a80cd4 Mon Sep 17 00:00:00 2001 From: "Kevin R. Thornton" Date: Sun, 6 Nov 2022 11:32:45 -0800 Subject: [PATCH] doc: show prelude contents as book appendix --- book/src/SUMMARY.md | 1 + book/src/prelude.md | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 book/src/prelude.md diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 7362380e7..2daa30992 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -15,5 +15,6 @@ - [Working with trees](./tree_sequence_tree.md) - [Miscellaneous operations](./tree_sequence_miscellaneous.md) +[Crate prelude](./prelude.md) [Changelog](./changelog.md) [Migration Guide](./migration_guide.md) diff --git a/book/src/prelude.md b/book/src/prelude.md new file mode 100644 index 000000000..561188f76 --- /dev/null +++ b/book/src/prelude.md @@ -0,0 +1,7 @@ +# The `tskit` prelude + +The contents of the crate prelude are: + +```rust, noplaygound, ignore +{{#include ../../src/prelude.rs}} +```