diff options
author | Jarrod Millman <jarrod.millman@gmail.com> | 2022-10-08 07:06:41 -0700 |
---|---|---|
committer | Jarrod Millman <jarrod.millman@gmail.com> | 2022-10-08 07:06:41 -0700 |
commit | 3a8a96cda5e04ef77caa076be1fcd115e3987b62 (patch) | |
tree | 067360b7f34814cccadab7156ecca464bddd7446 | |
parent | c6338c7607355f38c382017e5f492f50e1b44da9 (diff) | |
download | numpydoc-3a8a96cda5e04ef77caa076be1fcd115e3987b62.tar.gz |
Designate 1.5.0 releasev1.5.0
-rw-r--r-- | doc/release_notes.rst | 44 | ||||
-rw-r--r-- | numpydoc/_version.py | 2 |
2 files changed, 43 insertions, 3 deletions
diff --git a/doc/release_notes.rst b/doc/release_notes.rst index 54cb05b..1c9762d 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -21,11 +21,51 @@ Release notes 1.5.0 ----- -Release date: TBD +Release date: 8 October 2022 Requires Python 3.7+ and Sphinx 4.2+. -`Full Changelog <https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0rc1>`__ +`Full Changelog <https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0>`__ + +Fixed bugs +~~~~~~~~~~ + +- Parsing ``returns`` section with several types and no name `#428 <https://github.com/numpy/numpydoc/issues/428>`__ +- BUG: Fix returns parsing no name `#429 <https://github.com/numpy/numpydoc/pull/429>`__ (`rossbar <https://github.com/rossbar>`__) + +Closed issues +~~~~~~~~~~~~~ + +- readthedocs build failing `#439 <https://github.com/numpy/numpydoc/issues/439>`__ +- Exclude class properties from being listed under METHODS section `#339 <https://github.com/numpy/numpydoc/issues/339>`__ +- BUG: Numpydoc doesn’t render attributes decorated with ``cached\_property`` in the Attributes section `#432 <https://github.com/numpy/numpydoc/issues/432>`__ +- Is numpydoc_use_blockquotes deprecated or not yet? `#420 <https://github.com/numpy/numpydoc/issues/420>`__ +- No light theme available in docs `#413 <https://github.com/numpy/numpydoc/issues/413>`__ +- 1.4.0 release plan `#408 <https://github.com/numpy/numpydoc/issues/408>`__ + +Merged pull requests +~~~~~~~~~~~~~~~~~~~~ + +- Update doc requirements `#441 <https://github.com/numpy/numpydoc/pull/441>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Update pydata-sphinx-theme `#440 <https://github.com/numpy/numpydoc/pull/440>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Support Python 3.11 `#438 <https://github.com/numpy/numpydoc/pull/438>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Update precommit hooks `#437 <https://github.com/numpy/numpydoc/pull/437>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Use Python 3.10 to build docs `#436 <https://github.com/numpy/numpydoc/pull/436>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Use requirements/*.txt files for CI `#435 <https://github.com/numpy/numpydoc/pull/435>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Fix front page `#434 <https://github.com/numpy/numpydoc/pull/434>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Add cached property support `#433 <https://github.com/numpy/numpydoc/pull/433>`__ (`rossbar <https://github.com/rossbar>`__) +- ENH: Update validate.py to allow parameters with trailing underscores. `#425 <https://github.com/numpy/numpydoc/pull/425>`__ (`stefmolin <https://github.com/stefmolin>`__) +- DOC: Use ``:ref:`` when referring to section headers `#424 <https://github.com/numpy/numpydoc/pull/424>`__ (`namurphy <https://github.com/namurphy>`__) +- Remove numpydoc_use_blockquotes `#422 <https://github.com/numpy/numpydoc/pull/422>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Require sphinx>=4.2 (cleanup) `#421 <https://github.com/numpy/numpydoc/pull/421>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- docs: fix validation include line numbers `#418 <https://github.com/numpy/numpydoc/pull/418>`__ (`thatlittleboy <https://github.com/thatlittleboy>`__) +- Update precommit linters `#417 <https://github.com/numpy/numpydoc/pull/417>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- Update GH actions `#416 <https://github.com/numpy/numpydoc/pull/416>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) +- ENH: Add support for dict show_inherited_class_members `#415 <https://github.com/numpy/numpydoc/pull/415>`__ (`larsoner <https://github.com/larsoner>`__) +- DOC: Add theme switcher and default to lightmode. `#414 <https://github.com/numpy/numpydoc/pull/414>`__ (`rossbar <https://github.com/rossbar>`__) +- Require sphinx>=4.2 `#411 <https://github.com/numpy/numpydoc/pull/411>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__) + +\* *This Changelog was automatically generated by*\ `github_changelog_generator <https://github.com/github-changelog-generator/github-changelog-generator>`__ 1.4.0 ----- diff --git a/numpydoc/_version.py b/numpydoc/_version.py index 4e1da2b..5b60188 100644 --- a/numpydoc/_version.py +++ b/numpydoc/_version.py @@ -1 +1 @@ -__version__ = "1.5.0rc2.dev0" +__version__ = "1.5.0" |