From 2b3fba08767e50aeaa300b2cac8ace9a5d48ca16 Mon Sep 17 00:00:00 2001 From: daikitag <48062118+daikitag@users.noreply.github.com> Date: Thu, 24 Aug 2023 23:07:15 +0900 Subject: [PATCH 1/2] DOC: Symbolic links Symbolic link to CHANGELOG --- docs/CHANGELOG.md | 1 + docs/_toc.yml | 2 +- docs/release/index.md | 5 ----- docs/release/v0.0.1.md | 3 --- 4 files changed, 2 insertions(+), 9 deletions(-) create mode 120000 docs/CHANGELOG.md delete mode 100644 docs/release/index.md delete mode 100644 docs/release/v0.0.1.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 120000 index 0000000..04c99a5 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1 @@ +../CHANGELOG.md \ No newline at end of file diff --git a/docs/_toc.yml b/docs/_toc.yml index d49953b..a394516 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -22,6 +22,6 @@ parts: chapters: - file: citation - file: contributing - - file: release/index + - file: CHANGELOG - url: https://tskit.dev/community/ title: Community \ No newline at end of file diff --git a/docs/release/index.md b/docs/release/index.md deleted file mode 100644 index 2d2f62a..0000000 --- a/docs/release/index.md +++ /dev/null @@ -1,5 +0,0 @@ -(release)= - -# Release notes - -This is the list of changes to tstrait between each release. diff --git a/docs/release/v0.0.1.md b/docs/release/v0.0.1.md deleted file mode 100644 index fea37d7..0000000 --- a/docs/release/v0.0.1.md +++ /dev/null @@ -1,3 +0,0 @@ -# Version 0.0.1. - -Initial release of the tstrait package. From 5bcb6ca18935bd003533706a481bc463ddd7e3b4 Mon Sep 17 00:00:00 2001 From: daikitag <48062118+daikitag@users.noreply.github.com> Date: Fri, 25 Aug 2023 00:32:26 +0900 Subject: [PATCH 2/2] DOC: Version 0.0.1a2 update --- CHANGELOG.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 89c34c1..8b8b276 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog -## [0.0.1] - 2023-XX-XX +## [0.0.1a2] - 2023-XX-XX -Initial release of the package. \ No newline at end of file +### Highlights + +- Release of tstrait documentation in https://tskit.dev/tstrait/docs/latest/ + +### Fix + +- Hide private functions and classes {pr}`73` +- Modify docstring explanations and examples {pr}`76` + +### Documentation: + +- Create infrastructure for documentation {pr}`77` +- Build initial documentation {pr}`78` +- Add Changelog to documentation {pr}`79` + +### Contributors: + +- Daiki Tagami +- Gertjan Bisschop +- Jerome Kelleher + +## [0.0.1a1] - 2023-08-22 + +Initial alpha release of the package. + +### Contributors: + +- Daiki Tagami +- Gertjan Bisschop +- Jerome Kelleher \ No newline at end of file