This is a feature release, which includes new features, removes previously deprecated code, and adds new deprecations. The 3.0.x branch is now the supported fix branch, the 2.3.x branch will become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades. Test with warnings treated as errors to be able to adapt to deprecation warnings early.
Full Changelog <https://github.com/numpy/numpydoc/compare/v1.5.0...v1.6.0>__
Closed issues
- ``numpydoc ignore`` inline comment not recognized when using decorators `[#495](https://github.com/numpy/numpydoc/issues/495) <https://github.com/numpy/numpydoc/issues/495>`__
- Align pre-commit and Sphinx rule override syntax `[#466](https://github.com/numpy/numpydoc/issues/466) <https://github.com/numpy/numpydoc/issues/466>`__
- Use pyproject.toml `[#473](https://github.com/numpy/numpydoc/issues/473) <https://github.com/numpy/numpydoc/issues/473>`__
- rtd is failing `[#471](https://github.com/numpy/numpydoc/issues/471) <https://github.com/numpy/numpydoc/issues/471>`__
- circleci-artifacts-redirector-action error `[#469](https://github.com/numpy/numpydoc/issues/469) <https://github.com/numpy/numpydoc/issues/469>`__
- Incorporate a pre-commit hook for numpydoc validation `[#450](https://github.com/numpy/numpydoc/issues/450) <https://github.com/numpy/numpydoc/issues/450>`__
- PR06 fails when offending type name is used only as a substring `[#446](https://github.com/numpy/numpydoc/issues/446) <https://github.com/numpy/numpydoc/issues/446>`__
- style of ``[1]`` is strange in numpydoc docs `[#443](https://github.com/numpy/numpydoc/issues/443) <https://github.com/numpy/numpydoc/issues/443>`__
- Double click on function parameter selects parameter type as well `[#427](https://github.com/numpy/numpydoc/issues/427) <https://github.com/numpy/numpydoc/issues/427>`__
Merged pull requests
Bump actions/checkout from 3 to 4 [#504](https://github.com/numpy/numpydoc/issues/504) <https://github.com/numpy/numpydoc/pull/504>__ (dependabot[bot] <https://github.com/apps/dependabot>__)
BUG: validator now handles properties [#500](https://github.com/numpy/numpydoc/issues/500) <https://github.com/numpy/numpydoc/pull/500>__ (sdiebolt <https://github.com/sdiebolt>__)
Fix clean_backref for extensions that have backrefs to inline elements. [#499](https://github.com/numpy/numpydoc/issues/499) <https://github.com/numpy/numpydoc/pull/499>__ (mcmtroffaes <https://github.com/mcmtroffaes>__)
BUG: validator now handles decorators [#496](https://github.com/numpy/numpydoc/issues/496) <https://github.com/numpy/numpydoc/pull/496>__ (sdiebolt <https://github.com/sdiebolt>__)
TST: Test no-file for source [#493](https://github.com/numpy/numpydoc/issues/493) <https://github.com/numpy/numpydoc/pull/493>__ (larsoner <https://github.com/larsoner>__)
Use label-check and attach-next-milestone-action [#492](https://github.com/numpy/numpydoc/issues/492) <https://github.com/numpy/numpydoc/pull/492>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Use dependabot to update actions [#489](https://github.com/numpy/numpydoc/issues/489) <https://github.com/numpy/numpydoc/pull/489>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Add config for pre-commit bot [#488](https://github.com/numpy/numpydoc/issues/488) <https://github.com/numpy/numpydoc/pull/488>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Sync updates to generate_requirements.py from scikit-image [#485](https://github.com/numpy/numpydoc/issues/485) <https://github.com/numpy/numpydoc/pull/485>__ (mwtoews <https://github.com/mwtoews>__)
Generate requirements files from pyproject.toml [#483](https://github.com/numpy/numpydoc/issues/483) <https://github.com/numpy/numpydoc/pull/483>__ (mwtoews <https://github.com/mwtoews>__)
Add Source to project.urls table [#480](https://github.com/numpy/numpydoc/issues/480) <https://github.com/numpy/numpydoc/pull/480>__ (mwtoews <https://github.com/mwtoews>__)
Align behavior of pre-commit hook and Sphinx extension [#476](https://github.com/numpy/numpydoc/issues/476) <https://github.com/numpy/numpydoc/pull/476>__ (stefmolin <https://github.com/stefmolin>__)
Fix dynamic version specification. [#477](https://github.com/numpy/numpydoc/issues/477) <https://github.com/numpy/numpydoc/pull/477>__ (stefmolin <https://github.com/stefmolin>__)
Update year [#475](https://github.com/numpy/numpydoc/issues/475) <https://github.com/numpy/numpydoc/pull/475>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Use pyproject.toml [#474](https://github.com/numpy/numpydoc/issues/474) <https://github.com/numpy/numpydoc/pull/474>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Install package on rtd [#472](https://github.com/numpy/numpydoc/issues/472) <https://github.com/numpy/numpydoc/pull/472>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Add token for artifact redirector [#470](https://github.com/numpy/numpydoc/issues/470) <https://github.com/numpy/numpydoc/pull/470>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Use rtd template (old method is deprecated) [#468](https://github.com/numpy/numpydoc/issues/468) <https://github.com/numpy/numpydoc/pull/468>__ (jarrodmillman <https://github.com/jarrodmillman>__)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
- `@dependabot ignore minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
- `@dependabot ignore ` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore ` will remove all of the ignore conditions of the specified dependency
- `@dependabot unignore ` will remove the ignore condition of the specified dependency and ignore conditions
Bumps the pip-deps group in /requirements with 5 updates:
2.3.3
3.0.0
1.58.0
1.59.0
1.58.0
1.59.0
1.5.0
1.6.0
0.11.2
0.12.1
Updates
flask
from 2.3.3 to 3.0.0Release notes
Sourced from flask's releases.
Changelog
Sourced from flask's changelog.
Commits
735a470
Release version 3.0.0efe39ae
Bump Werkzeug 3.0.0438edcd
Allow self as an argument to url_forb7c1290
Fix wrong spelling of JS method .innerHTML8037487
Bump pypa/gh-action-pypi-publish from 1.8.8 to 1.8.10 (#5248)e8076d9
Bump slsa-framework/slsa-github-generator from 1.7.0 to 1.9.0 (#5247)ecc4a38
Bump actions/checkout from 3.5.3 to 3.6.0 (#5246)24c6508
Bump pypa/gh-action-pypi-publish from 1.8.8 to 1.8.1098cef9f
Bump slsa-framework/slsa-github-generator from 1.7.0 to 1.9.00c97a41
Bump actions/checkout from 3.5.3 to 3.6.0Updates
grpcio
from 1.58.0 to 1.59.0Release notes
Sourced from grpcio's releases.
... (truncated)
Commits
08cc178
[Release] Bump v1.59.x version to 1.59.0 (#34534)deb0c62
[Release] Bump v1.59.x to v1.59.0-pre2 (#34505)b41d33b
[backport][EventEngine] Fix ThreadCount aligned storage for C++14 and earlier...7e5bae3
[Deps] Backport to v1.59.x: Fully vendored upb again (#34514)4958cb9
[test] Fix venv version installed on Fedora 26 (#34477) (#34494)bb97419
[Release] Bump 1.59.x version to 1.59.0-pre1 (#34490)3f9417a
[PSM Interop] SSA: Remove failfast=True (#34478)bc4d81d
Bump core version 202309251628 (#34476)df4c0c6
[exec-ctx] Remove ScopedTimeCache from ExecCtx on iOS (#34416)fe70af2
[interop] Add v1.58.2 release of grpc-go to interop matrix (#34449)Updates
grpcio-tools
from 1.58.0 to 1.59.0Release notes
Sourced from grpcio-tools's releases.
... (truncated)
Commits
08cc178
[Release] Bump v1.59.x version to 1.59.0 (#34534)deb0c62
[Release] Bump v1.59.x to v1.59.0-pre2 (#34505)b41d33b
[backport][EventEngine] Fix ThreadCount aligned storage for C++14 and earlier...7e5bae3
[Deps] Backport to v1.59.x: Fully vendored upb again (#34514)4958cb9
[test] Fix venv version installed on Fedora 26 (#34477) (#34494)bb97419
[Release] Bump 1.59.x version to 1.59.0-pre1 (#34490)3f9417a
[PSM Interop] SSA: Remove failfast=True (#34478)bc4d81d
Bump core version 202309251628 (#34476)df4c0c6
[exec-ctx] Remove ScopedTimeCache from ExecCtx on iOS (#34416)fe70af2
[interop] Add v1.58.2 release of grpc-go to interop matrix (#34449)Updates
numpydoc
from 1.5.0 to 1.6.0Changelog
Sourced from numpydoc's changelog.
... (truncated)
Commits
ac7ba53
Designate 1.6.0 release229a4ff
Bump actions/checkout from 3 to 4 (#504)881c0ab
BUG: validator now handles properties (#500)ecd24ab
[pre-commit.ci] pre-commit autoupdate (#501)df55b8a
BUG: validator now handles decorators (#496)307992e
BUG: Fix clean_backref for extensions that have backrefs to inline elements. ...6e748ef
Bump versionddeba36
Designate 1.6.0rc2 released9a3dfe
TST: Test no-file for source (#493)41a1508
Use label-check and attach-next-milestone-action (#492)Updates
ansys-sphinx-theme
from 0.11.2 to 0.12.1Release notes
Sourced from ansys-sphinx-theme's releases.
Commits
a575e8b
ver: bump 0.12.1928a229
fix : update the js compactible with require.js module loader (#308)c8021e7
ver: bump 0.12.0 version646bdc0
fix: styles with sphinx design elements (#306)a3d9b17
Build(deps-dev): Bump numpydoc from 1.5.0 to 1.6.0 (#305)e18b077
fix: update the extension if condition (#299)b383204
fix: update the styles with pydata-sphinx-theme update (#300)1f25c17
Build(deps-dev): Bump pydata-sphinx-theme from 0.14.0 to 0.14.1 (#304)d9fe77c
fix: try except to handle value error for linkcode extension (#297)df79ffa
Build(deps-dev): Bump pydata-sphinx-theme from 0.13.3 to 0.14.0 (#295)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show