Update docs

Signed-off-by: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>

Author: thombashi

docs/index.rst

@@ -16,6 +16,7 @@ Welcome to DateTimeRange's documentation!
    pages/introduction/index
    pages/examples/index
    pages/reference/index
+   pages/CHANGELOG
    pages/links
 
 

docs/pages/CHANGELOG.rst

@@ -0,0 +1,277 @@
+#
+`v2.2.1 <https://github.com/thombashi/DateTimeRange/releases/tag/v2.2.1>`__
+- 07 Apr 2024
+
+What’s Changed
+==============
+
+-  Bump actions/setup-python from 4 to 5 by
+   [@dependabot](https://github.com/dependabot) in
+   https://github.com/thombashi/DateTimeRange/pull/47
+-  Fix an error that ``DateTimeRange.intersection`` method failed when
+   the ranges are not overlapped and the ``intersection_threshold`` is
+   not ``None``:
+   `#48 <https://github.com/thombashi/DateTimeRange/issues/48>`__
+   (Thanks to [@wernersa](https://github.com/wernersa))
+-  Keep the timezone when perform ``__iadd__`` or ``__isub__``
+   operations
+-  Add a build and publish workflow
+-  Add Sigstore signatures to release assets
+
+New Contributors
+================
+
+-  [@dependabot](https://github.com/dependabot) made their first
+   contribution in https://github.com/thombashi/DateTimeRange/pull/47
+
+**Full Changelog**:
+https://github.com/thombashi/DateTimeRange/compare/v2.2.0…v2.2.1
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v2.2.0...v2.2.1>`__
+
+#
+`v2.2.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v2.2.0>`__
+- 03 Oct 2023
+
+-  Add ``timezone`` as an optional argument to ``set_time_range``
+   method, ``from_range_text`` method and the ``DateTimeRange`` class
+   constructor
+-  Add ``timezone`` property to ``DateTimeRange`` class
+-  Add support for Python 3.12
+-  Change ``start_time_format`` and ``end_time_format`` of the
+   ``DateTimeRange`` class constructor to optional arguments
+
+   -  Default format value would not be changed
+
+-  Fix type annotations of ``set_start_datetime`` and
+   ``set_end_datetime`` methods
+-  Bump minimum ``typepy`` version to 1.3.2
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v2.1.1...v2.2.0>`__
+
+#
+`v2.1.1 <https://github.com/thombashi/DateTimeRange/releases/tag/v2.1.1>`__
+- 01 Oct 2023
+
+-  Add ``__all__`` to ``__init__.py``
+-  Add ``docs`` extras
+-  Add ``zip_safe=False``
+-  Add a classifier
+-  Update ``[build-system]``
+-  Modify to use ``pypa/build`` for package build
+
+**Full Changelog**:
+https://github.com/thombashi/DateTimeRange/compare/v2.1.0…v2.1.1
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v2.1.0...v2.1.1>`__
+
+#
+`v2.1.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v2.1.0>`__
+- 19 Feb 2023
+
+.. _whats-changed-1:
+
+What’s Changed
+==============
+
+-  Add type annotations by
+   [@hauntsaninja](https://github.com/hauntsaninja) in
+   https://github.com/thombashi/DateTimeRange/pull/45
+-  Changes to make ``datetime.timedelta`` and
+   ``dateutil.relativedelta.relativedelta`` transparently usable for
+   arguments.
+
+.. _new-contributors-1:
+
+New Contributors
+================
+
+-  [@hauntsaninja](https://github.com/hauntsaninja) made their first
+   contribution in https://github.com/thombashi/DateTimeRange/pull/45
+
+**Full Changelog**:
+https://github.com/thombashi/DateTimeRange/compare/v2.0.0…v2.1.0
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v2.0.0...v2.1.0>`__
+
+#
+`v2.0.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v2.0.0>`__
+- 11 Feb 2023
+
+-  Add ``intersection_threshold`` argument to
+   ``intersection``/``is_intersection`` methods:
+   `#43 <https://github.com/thombashi/DateTimeRange/issues/43>`__
+   (Thanks to [@usman5251](https://github.com/usman5251))
+-  Modify to accept regular expression for separator argument of
+   ``from_range_text`` method:
+   `#41 <https://github.com/thombashi/DateTimeRange/issues/41>`__
+   (Thanks to [@pantierra](https://github.com/pantierra))
+-  Fix the behavior of range when traversing from end to start:
+   `#44 <https://github.com/thombashi/DateTimeRange/issues/44>`__
+   (Thanks to [@4l1fe](https://github.com/4l1fe))
+-  Drop support for Python 3.6
+-  Add support for Python 3.11
+
+**Full Changelog**:
+https://github.com/thombashi/DateTimeRange/compare/v1.2.0…v2.0.0
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v1.2.0...v2.0.0>`__
+
+#
+`v1.2.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v1.2.0>`__
+- 10 Jul 2021
+
+-  Add ``DateTimeRange.from_range_text`` class method:
+   `#38 <https://github.com/thombashi/DateTimeRange/issues/38>`__
+   (Thanks to [@noamsgl](https://github.com/noamsgl))
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v1.1.0...v1.2.0>`__
+
+#
+`v1.1.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v1.1.0>`__
+- 09 Jun 2021
+
+-  Add ``subtract`` method to ``DateTimeRange`` class:
+   `#36 <https://github.com/thombashi/DateTimeRange/issues/36>`__
+   (Thanks to [@bramski](https://github.com/bramski))
+-  Add ``split`` method to ``DateTimeRange`` class
+-  Add support for Python 3.10
+-  Drop support for Python 3.5
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.5.0...v1.1.0>`__
+
+#
+`v0.5.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.5.0>`__
+- 31 Oct 2018
+
+-  Change to return a new instance instead of changing the instance
+   value itself when using ``intersection``/``encompass`` methods
+   `#31 <https://github.com/thombashi/DateTimeRange/issues/31>`__
+   (Thanks to [@camelia-c](https://github.com/camelia-c))
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.4.0...v0.5.0>`__
+
+#
+`v0.4.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.4.0>`__
+- 30 Oct 2018
+
+-  Add support for ``datetime.date`` class
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.3.6...v0.4.0>`__
+
+#
+`v0.3.6 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.3.6>`__
+- 15 Sep 2018
+
+-  Add support for Python 3.7
+-  Update the package metadata
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.6...v0.3.6>`__
+
+#
+`v0.2.6 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.6>`__
+- 17 Nov 2016
+
+-  Fix to apply dependent package update
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.5...v0.2.6>`__
+
+#
+`v0.2.5 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.5>`__
+- 11 Aug 2016
+
+-  Refactoring
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.4...v0.2.5>`__
+
+#
+`v0.2.4 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.4>`__
+- 09 Jul 2016
+
+-  Drop support for Python 2.6
+-  Fix datetime detection error with version strings
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.3...v0.2.4>`__
+
+#
+`v0.2.3 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.3>`__
+- 03 Jul 2016
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.2...v0.2.3>`__
+
+#
+`v0.2.2 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.2>`__
+- 19 Jun 2016
+
+-  Make pytest-runner a conditional requirement
+-  Drop support for Python 2.5
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.1...v0.2.2>`__
+
+#
+`v0.2.1 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.1>`__
+- 15 Mar 2016
+
+Enhancement
+===========
+
+`#12 <https://github.com/thombashi/DateTimeRange/issues/12>`__: Added
+support for datetimerange inclusion. Thanks to
+[@guyzmo](https://github.com/guyzmo)
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.2.0...v0.2.1>`__
+
+#
+`v0.2.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.2.0>`__
+- 10 Mar 2016
+
+.. _enhancement-1:
+
+Enhancement
+===========
+
+-  Add range method to support iterator.
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.1.3...v0.2.0>`__
+
+#
+`v0.1.3 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.1.3>`__
+- 04 Mar 2016
+
+Fix
+===
+
+-  Fix `#8 <https://github.com/thombashi/DateTimeRange/issues/8>`__:
+   correct daylight savings time processing. Thanks to
+   [@tweyter](https://github.com/tweyter)
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.1.2...v0.1.3>`__
+
+#
+`v0.1.2 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.1.2>`__
+- 25 Feb 2016
+
+.. _enhancement-2:
+
+Enhancement
+-----------
+
+-  add operator support: ``!=``, ``+``, ``+=``, ``-``, ``-=``
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.1.1...v0.1.2>`__
+
+#
+`v0.1.1 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.1.1>`__
+- 20 Feb 2016
+
+`Changes <https://github.com/thombashi/DateTimeRange/compare/v0.1.0...v0.1.1>`__
+
+#
+`v0.1.0 <https://github.com/thombashi/DateTimeRange/releases/tag/v0.1.0>`__
+- 19 Feb 2016
+
+`Changes <https://github.com/thombashi/DateTimeRange/tree/v0.1.0>`__
+
+.. raw:: html
+
+   <!-- Generated by https://github.com/rhysd/changelog-from-release v3.7.2 -->

docs/pages/introduction/badges.txt

@@ -1,4 +1,4 @@
-|PyPI pkg ver| |conda pkg ver| |Supported Python versions| |CI status| |Test coverage| |CodeQL|
+|PyPI pkg ver| |conda pkg ver| |Supported Python ver| |CI status| |Test coverage| |CodeQL|
 
 .. |PyPI pkg ver| image:: https://badge.fury.io/py/DateTimeRange.svg
     :target: https://badge.fury.io/py/DateTimeRange
@@ -8,7 +8,7 @@
     :target: https://anaconda.org/conda-forge/datetimerange
     :alt: conda-forge package version
 
-.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/DateTimeRange.svg
+.. |Supported Python ver| image:: https://img.shields.io/pypi/pyversions/DateTimeRange.svg
     :target: https://pypi.org/project/DateTimeRange
     :alt: Supported Python versions