From a3319680334058c33ce8d9913a8a12c548a818ae Mon Sep 17 00:00:00 2001 From: "Kevin R. Thornton" Date: Fri, 24 Jan 2025 11:33:09 -0800 Subject: [PATCH] doc: add links to the manual (#705) --- README.md | 3 +++ src/lib.rs | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index a440f3b22..0094820ea 100644 --- a/README.md +++ b/README.md @@ -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`: diff --git a/src/lib.rs b/src/lib.rs index d91935c73..22c963077 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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)]