Skip to content

Commit

Permalink
doc: add links to the manual (#705)
Browse files Browse the repository at this point in the history
  • Loading branch information
molpopgen authored Jan 24, 2025
1 parent 187bf3e commit a331968
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ cargo test --all-features
cargo doc --all-features --open
```

API documentation for the latest release is [here](https://docs.rs/tskit).
A manual is [here](https://tskit-dev.github.io/tskit-rust).

### Calculating code coverage

First, install `tarpaulin`:
Expand Down
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@
//!
//! * A lot of wrappers to the C functions.
//! * Tree sequence statistics!
//!
//! # Manual
//!
//! A manual is [here](https://tskit-dev.github.io/tskit-rust).
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
Expand Down

0 comments on commit a331968

Please sign in to comment.