From b5d3777618339f610d8da59b2f4cfd27022ff35a Mon Sep 17 00:00:00 2001 From: Sean Freeman Date: Sat, 20 Dec 2025 22:19:46 -0600 Subject: [PATCH] Add a what's new page, linking to the changelog --- CHANGELOG.md | 34 +++++++++++++++++----------------- doc/userguide/index.md | 1 + doc/userguide/whats_new.md | 9 +++++++++ 3 files changed, 27 insertions(+), 17 deletions(-) create mode 100644 doc/userguide/whats_new.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d170210..17616682 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ -### Tobac Changelog +# Tobac Changelog -_**Version 1.6.2:**_ +## Version 1.6.2 **Enhancements for Users** @@ -18,14 +18,14 @@ _**Version 1.6.2:**_ - Updated pyproject.toml and removed setup.py to support eventual release on PyPi [#537](https://github.com/tobac-project/tobac/pull/537) -_**Version 1.6.1:**_ +## Version 1.6.1 **Bug fixes** - An bug in the `field_and_features_over_time` generator, used to loop through mask `DataArrays` and feature `Dataframes` simultaneously which caused an error in the dataframe had no 0 index value has been fixed [#506](https://github.com/tobac-project/tobac/pull/506) - Interpolation of non-numeric coordinates (such as datetime) now works, and chooses the nearest element [#509](https://github.com/tobac-project/tobac/pull/509) -_**Version 1.6.0:**_ +## Version 1.6.0 **Enhancements for Users** @@ -44,7 +44,7 @@ _**Version 1.6.0:**_ - `tobac.utils.internal.basic` was restructured into `coordinates` and `label_props` utils, and new `datetime` and `generators` utils were added [#489](https://github.com/tobac-project/tobac/pull/489) -_**Version 1.5.5:**_ +## Version 1.5.5 **Bug fixes** @@ -56,7 +56,7 @@ _**Version 1.5.5:**_ - Fix matrix testing to use the specified python versions [#468](https://github.com/tobac-project/tobac/pull/468) -_**Version 1.5.4:**_ +## Version 1.5.4 **Enhancements for Users** @@ -86,7 +86,7 @@ _**Version 1.5.4:**_ - Resolved issues around updating dependencies in `black` formatting checks and Zenodo JSON checks [#457](https://github.com/tobac-project/tobac/pull/457) -_**Version 1.5.3:**_ +## Version 1.5.3 **Enhancements for Users** @@ -107,7 +107,7 @@ _**Version 1.5.3:**_ - Reorganisation of analysis tools into analysis package [#378](https://github.com/tobac-project/tobac/pull/378) -_**Version 1.5.2:**_ +## Version 1.5.2 **Enhancements for Users** @@ -142,7 +142,7 @@ _**Version 1.5.2:**_ - Pylint CI workflow added to assess code quality and compare to base branch [#373](https://github.com/tobac-project/tobac/pull/373) -_**Version 1.5.1:**_ +## Version 1.5.1 **Bug fixes** @@ -157,7 +157,7 @@ _**Version 1.5.1:**_ - Fix to Jupyter Notebook CI that was timing out due to installing packages with `conda`, switched to `mamba` to resolve. [#340](https://github.com/tobac-project/tobac/pull/340) -_**Version 1.5.0:**_ +## Version 1.5.0 **Enhancements for Users** @@ -212,7 +212,7 @@ _**Version 1.5.0:**_ -_**Version 1.4.2:**_ +## Version 1.4.2 **Bug fixes** @@ -224,7 +224,7 @@ _**Version 1.4.2:**_ - Fixed an issue in the 2D coordinate interpolation that produced object dtypes in feature detection and made the feature input data frame incompatible with the merge and split function [#251](https://github.com/tobac-project/tobac/pull/251) -_**Version 1.4.1:**_ +## Version 1.4.1 **Bug fixes** @@ -235,7 +235,7 @@ _**Version 1.4.1:**_ - Regenerated example notebooks so that they are up to date for the present version [#233](https://github.com/tobac-project/tobac/pull/233) -_**Version 1.4.0:**_ +## Version 1.4.0 **Enhancements** @@ -272,13 +272,13 @@ _**Version 1.4.0:**_ - Support for Python 3.6 and earlier is now deprecated and will be removed in v1.5.0 ([#193](https://github.com/tobac-project/tobac/pull/193)) -_**Version 1.3.3:**_ +## Version 1.3.3 **Bug fixes** - Added a workaround to a bug in trackpy that fixes predictive tracking [#170](https://github.com/tobac-project/tobac/pull/170) -_**Version 1.3.2:**_ +## Version 1.3.2 **Bug fixes** @@ -290,7 +290,7 @@ _**Version 1.3.2:**_ - Added automatic code coverage reports [#124](https://github.com/tobac-project/tobac/pull/124) - Added automatic building of readthedocs documentation on pull requests -_**Version 1.3.1:**_ +## Version 1.3.1 **Enhancements** @@ -304,7 +304,7 @@ _**Version 1.3.1:**_ - New pull request template for the repository, including a checklist to be completed for each pull request [#120](https://github.com/tobac-project/tobac/pull/120) -_**Version 1.3:**_ +## Version 1.3 **Enhancements** diff --git a/doc/userguide/index.md b/doc/userguide/index.md index 9f52c7e0..9aaaab08 100644 --- a/doc/userguide/index.md +++ b/doc/userguide/index.md @@ -18,6 +18,7 @@ tracking/index bulk_statistics/index big_datasets analysis +whats_new publications governance diff --git a/doc/userguide/whats_new.md b/doc/userguide/whats_new.md new file mode 100644 index 00000000..6af53ec7 --- /dev/null +++ b/doc/userguide/whats_new.md @@ -0,0 +1,9 @@ +# What's New + +## New Feature Highlights + +- New documentation pages (this page right here) +- [Enhanced examples](../examples/index) + +```{include} ../../CHANGELOG.md +```