Skip to content

doc: show prelude contents as book appendix #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2022
Merged

doc: show prelude contents as book appendix #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: show prelude contents as book appendix
  • Loading branch information
@molpopgen
molpopgen committed Nov 6, 2022
commit 07a124765724bcd4c818efbfc8d4381d04a80cd4
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
7 changes: 7 additions & 0 deletions book/src/prelude.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# The `tskit` prelude

The contents of the crate prelude are:

```rust, noplaygound, ignore
{{#include ../../src/prelude.rs}}
```