@@ -17,13 +17,68 @@ Release notes
17
17
For release notes (sparsely) kept prior to 1.0.0, look at the `releases page
18
18
on GitHub <https://github.com/numpy/numpydoc/releases> `__.
19
19
20
- 1.6.0rc2
21
- --------
20
+ 1.6.0
21
+ -----
22
22
23
23
Release date: 21 August 2023
24
24
25
25
Requires Python 3.8+ and Sphinx 5+.
26
26
27
+ `Full Changelog <https://github.com/numpy/numpydoc/compare/v1.5.0...v1.6.0 >`__
28
+
29
+ Closed issues
30
+ ~~~~~~~~~~~~~
31
+
32
+ - ``numpydoc ignore `` inline comment not recognized when using decorators `#495 <https://github.com/numpy/numpydoc/issues/495 >`__
33
+ - Align pre-commit and Sphinx rule override syntax `#466 <https://github.com/numpy/numpydoc/issues/466 >`__
34
+ - Use pyproject.toml `#473 <https://github.com/numpy/numpydoc/issues/473 >`__
35
+ - rtd is failing `#471 <https://github.com/numpy/numpydoc/issues/471 >`__
36
+ - circleci-artifacts-redirector-action error `#469 <https://github.com/numpy/numpydoc/issues/469 >`__
37
+ - Incorporate a pre-commit hook for numpydoc validation `#450 <https://github.com/numpy/numpydoc/issues/450 >`__
38
+ - PR06 fails when offending type name is used only as a substring `#446 <https://github.com/numpy/numpydoc/issues/446 >`__
39
+ - style of ``[1] `` is strange in numpydoc docs `#443 <https://github.com/numpy/numpydoc/issues/443 >`__
40
+ - Double click on function parameter selects parameter type as well `#427 <https://github.com/numpy/numpydoc/issues/427 >`__
41
+
42
+ Merged pull requests
43
+ ~~~~~~~~~~~~~~~~~~~~
44
+
45
+ - Bump actions/checkout from 3 to 4 `#504 <https://github.com/numpy/numpydoc/pull/504 >`__ (`dependabot[bot] <https://github.com/apps/dependabot >`__)
46
+ - [pre-commit.ci] pre-commit autoupdate `#501 <https://github.com/numpy/numpydoc/pull/501 >`__ (`pre-commit-ci[bot] <https://github.com/apps/pre-commit-ci >`__)
47
+ - BUG: validator now handles properties `#500 <https://github.com/numpy/numpydoc/pull/500 >`__ (`sdiebolt <https://github.com/sdiebolt >`__)
48
+ - Fix clean_backref for extensions that have backrefs to inline elements. `#499 <https://github.com/numpy/numpydoc/pull/499 >`__ (`mcmtroffaes <https://github.com/mcmtroffaes >`__)
49
+ - BUG: validator now handles decorators `#496 <https://github.com/numpy/numpydoc/pull/496 >`__ (`sdiebolt <https://github.com/sdiebolt >`__)
50
+ - TST: Test no-file for source `#493 <https://github.com/numpy/numpydoc/pull/493 >`__ (`larsoner <https://github.com/larsoner >`__)
51
+ - Use label-check and attach-next-milestone-action `#492 <https://github.com/numpy/numpydoc/pull/492 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
52
+ - Remove old linter check (using precommit bot now) `#491 <https://github.com/numpy/numpydoc/pull/491 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
53
+ - Update pydata-sphinx-theme `#490 <https://github.com/numpy/numpydoc/pull/490 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
54
+ - Use dependabot to update actions `#489 <https://github.com/numpy/numpydoc/pull/489 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
55
+ - Add config for pre-commit bot `#488 <https://github.com/numpy/numpydoc/pull/488 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
56
+ - Update pre-commits `#487 <https://github.com/numpy/numpydoc/pull/487 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
57
+ - Sync updates to generate_requirements.py from scikit-image `#485 <https://github.com/numpy/numpydoc/pull/485 >`__ (`mwtoews <https://github.com/mwtoews >`__)
58
+ - Generate requirements files from pyproject.toml `#483 <https://github.com/numpy/numpydoc/pull/483 >`__ (`mwtoews <https://github.com/mwtoews >`__)
59
+ - Add Source to project.urls table `#480 <https://github.com/numpy/numpydoc/pull/480 >`__ (`mwtoews <https://github.com/mwtoews >`__)
60
+ - Align behavior of pre-commit hook and Sphinx extension `#476 <https://github.com/numpy/numpydoc/pull/476 >`__ (`stefmolin <https://github.com/stefmolin >`__)
61
+ - Fix dynamic version specification. `#477 <https://github.com/numpy/numpydoc/pull/477 >`__ (`stefmolin <https://github.com/stefmolin >`__)
62
+ - Update year `#475 <https://github.com/numpy/numpydoc/pull/475 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
63
+ - Use pyproject.toml `#474 <https://github.com/numpy/numpydoc/pull/474 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
64
+ - Install package on rtd `#472 <https://github.com/numpy/numpydoc/pull/472 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
65
+ - Add token for artifact redirector `#470 <https://github.com/numpy/numpydoc/pull/470 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
66
+ - Use rtd template (old method is deprecated) `#468 <https://github.com/numpy/numpydoc/pull/468 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
67
+ - Update doc requirements `#465 <https://github.com/numpy/numpydoc/pull/465 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
68
+ - Update pre-commit hooks `#464 <https://github.com/numpy/numpydoc/pull/464 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
69
+ - Drop Python 3.7 `#462 <https://github.com/numpy/numpydoc/pull/462 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
70
+ - Require Sphinx 5+ `#461 <https://github.com/numpy/numpydoc/pull/461 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
71
+ - Pre-commit hook for running numpydoc validation `#454 <https://github.com/numpy/numpydoc/pull/454 >`__ (`stefmolin <https://github.com/stefmolin >`__)
72
+ - MAINT: Compatibility with pydata-sphinx-theme `#453 <https://github.com/numpy/numpydoc/pull/453 >`__ (`larsoner <https://github.com/larsoner >`__)
73
+ - MAINT: Refactoring ``get_doc_object `` `#452 <https://github.com/numpy/numpydoc/pull/452 >`__ (`F3eQnxN3RriK <https://github.com/F3eQnxN3RriK >`__)
74
+ - Update blacken-docs repo after owner transfer. `#451 <https://github.com/numpy/numpydoc/pull/451 >`__ (`stefmolin <https://github.com/stefmolin >`__)
75
+ - Update pre-commit `#449 <https://github.com/numpy/numpydoc/pull/449 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
76
+ - MAINT: Fix CIs for sphinx 6 `#448 <https://github.com/numpy/numpydoc/pull/448 >`__ (`larsoner <https://github.com/larsoner >`__)
77
+ - Change PR06 logic to only fail when type is used standalone `#447 <https://github.com/numpy/numpydoc/pull/447 >`__ (`amoeba <https://github.com/amoeba >`__)
78
+ - Fix release notes `#442 <https://github.com/numpy/numpydoc/pull/442 >`__ (`jarrodmillman <https://github.com/jarrodmillman >`__)
79
+
80
+ \* *This Changelog was automatically generated by * `github_changelog_generator <https://github.com/github-changelog-generator/github-changelog-generator >`__
81
+
27
82
1.5.0
28
83
-----
29
84
0 commit comments