From 9eb1108361308ac08aba039f408dffd33a55e914 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sun, 28 Jul 2024 08:14:31 +1200 Subject: [PATCH] Changelog entry for v0.1.4 (#59) * Add changelog entries for versions 0.1.0 to 0.1.3 Start a changelog for all the previous 0.1.x releases. Putting it under the Reference section in the sidebar (renamed from API Reference). * Changelog entry for v0.1.4 Patch release with numerous documentation improvements. * Update copyright year and release in docs/conf.py --- docs/api.rst | 4 +- docs/changelog.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 4 +- docs/index.md | 5 ++- 4 files changed, 105 insertions(+), 6 deletions(-) create mode 100644 docs/changelog.md diff --git a/docs/api.rst b/docs/api.rst index c1ad4c3..70d22b0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,5 @@ -API -=== +API Reference +============= .. currentmodule:: xarray diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..cb9a615 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,98 @@ +# Changelog + +## Version 0.1.4 - 2024-07-27 + +This release brings several documentation improvements at + with a new User Guide, Tutorials and Presentations, +Contributing Guide and API reference. It also fixes a `No module named +'xarray.core.pycompat'` bug, and will require a minimum version of `xarray>=2024.02.0`. + +### What's Changed + +- Documentation Updates 📖 ([#35](https://github.com/xarray-contrib/cupy-xarray/pull/35)) +- Update accessors.py ([#42](https://github.com/xarray-contrib/cupy-xarray/pull/42)) +- Enable API reference docs to show accessor methods ([#44](https://github.com/xarray-contrib/cupy-xarray/pull/44)) +- Migrate flake8, isort, black rules to ruff ([#49](https://github.com/xarray-contrib/cupy-xarray/pull/49)) +- Fix broken doctest and tests on accessors ([#46](https://github.com/xarray-contrib/cupy-xarray/pull/46)) +- Migrate from setup.cfg to pyproject.toml ([#48](https://github.com/xarray-contrib/cupy-xarray/pull/48)) + +### Contributors + +- [Wei Ji Leong](https://github.com/weiji14) +- [Negin Sobhani](https://github.com/negin513) +- [Sai Shashank](https://github.com/saishashank85) + +**Full Changelog**: + +--- + +## Version 0.1.3 - 2023-02-22 + +### What's Changed + +- Set encoding for Windows ([#20](https://github.com/xarray-contrib/cupy-xarray/pull/20)) +- Fix broken dask_array_type import ([#24](https://github.com/xarray-contrib/cupy-xarray/pull/24)) +- Min xarray >= 0.19.0 ([#25](https://github.com/xarray-contrib/cupy-xarray/pull/25)) +- Expand installation doc ([#27](https://github.com/xarray-contrib/cupy-xarray/pull/27)) + +### Contributors + +- [Deepak Cherian](https://github.com/dcherian) +- [Aaron Zuspan](https://github.com/aazuspan) +- [Aleksandr Kadykov](https://github.com/kadykov) + +**Full Changelog**: + +--- + +## Version 0.1.2 - 2022-08-25 + +### What's Changed + +- Add badges ([#16](https://github.com/xarray-contrib/cupy-xarray/pull/16)) +- update PyPI workflow: double-check we're shipping everything we need ([#17](https://github.com/xarray-contrib/cupy-xarray/pull/17)) +- PyPI workflow: re-introduce upload job ([#18](https://github.com/xarray-contrib/cupy-xarray/pull/18)) +- Revert back to previous version of PyPI workflow ([#19](https://github.com/xarray-contrib/cupy-xarray/pull/19)) + +### Contributors + +- [Deepak Cherian](https://github.com/dcherian) +- [Anderson Banihirwe](https://github.com/andersy005) + +**Full Changelog**: + +--- + +## Version 0.1.1 - 2022-08-19 + +_First release!_ + +### What's Changed + +- Add LICENSE ([#2](https://github.com/xarray-contrib/cupy-xarray/pull/2)) +- Update path of repo ([#3](https://github.com/xarray-contrib/cupy-xarray/pull/3)) +- Add docs ([#4](https://github.com/xarray-contrib/cupy-xarray/pull/4)) +- Update versioneer ([#12](https://github.com/xarray-contrib/cupy-xarray/pull/12)) +- Add PyPI release workflow ([#13](https://github.com/xarray-contrib/cupy-xarray/pull/13)) +- Fix CI job dependency ([#14](https://github.com/xarray-contrib/cupy-xarray/pull/14)) + +### Contributors + +- [Jacob Tomlinson](https://github.com/jacobtomlinson) +- [Ray Bell](https://github.com/raybellwaves) +- [Deepak Cherian](https://github.com/dcherian) +- [Anderson Banihirwe](https://github.com/andersy005) + +**Full Changelog**: + +--- + +## Version 0.1.0 - 2020-07-23 + +_Pre-release_ + +### Contributors + +- [Jacob Tomlinson](https://github.com/jacobtomlinson) + +**Full Changelog**: diff --git a/docs/conf.py b/docs/conf.py index 1ba6a75..2dffa80 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,9 +11,9 @@ import cupy_xarray # noqa: F401 project = "cupy-xarray" -copyright = "2023, cupy-xarray developers" +copyright = "2020-2024, cupy-xarray developers" author = "cupy-xarray developers" -release = "v0.1" +release = "v0.1.4" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/index.md b/docs/index.md index 3bbd9a0..fdea96c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -76,11 +76,12 @@ Large parts of this documentations comes from [SciPy 2023 Xarray on GPUs tutoria source/contributing -**API Reference**: +**Reference**: .. toctree:: :maxdepth: 1 - :caption: API Reference + :caption: Reference api + changelog ```