From 8194a1a0d1c78cb502d2024a3380cc9457de7fe9 Mon Sep 17 00:00:00 2001 From: Yiming Yang Date: Mon, 22 Apr 2024 11:43:26 -0700 Subject: [PATCH] update docs --- docs/conf.py | 4 ++-- docs/index.rst | 2 +- docs/release_notes.rst | 5 +++++ docs/release_notes/version_2_6.rst | 14 ++++++++++++++ 4 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/release_notes/version_2_6.rst diff --git a/docs/conf.py b/docs/conf.py index d899f6ea..17a048fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,9 +24,9 @@ author = 'Yiming Yang, Joshua Gould and Bo Li' # The short X.Y version -version = '2.5' +version = '2.6' # The full version, including alpha/beta/rc tags -release = '2.5.0' +release = '2.6.0' # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 0959dc91..404ac870 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,7 +5,7 @@ Release Highlights in Current Stable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: release_notes/version_2_5.rst +.. include:: release_notes/version_2_6.rst .. toctree:: :maxdepth: 1 diff --git a/docs/release_notes.rst b/docs/release_notes.rst index a3ea2314..58311ee9 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -3,6 +3,11 @@ Release notes .. role:: small +Version 2.6 +~~~~~~~~~~~~~~ + +.. include:: release_notes/version_2_6.rst + Version 2.5 ~~~~~~~~~~~~~~ diff --git a/docs/release_notes/version_2_6.rst b/docs/release_notes/version_2_6.rst new file mode 100644 index 00000000..0572cef2 --- /dev/null +++ b/docs/release_notes/version_2_6.rst @@ -0,0 +1,14 @@ +2.6.0 :small:`April 22, 2024` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Update:** + +* In Cellranger workflow: + + * Upgrade *cellranger_version* default to ``8.0.0``. + * Upgrade *cumulus_feature_barcoding* version default to ``0.11.3``. + +* In Spaceranger workflow: + + * Upgrade *spaceranger_version* default to ``3.0.0``. + * Support Visium HD data.