1.9.0

We're happy to announce the release of numpydoc 1.9.0!

Enhancements

• ignore some errors at module level (#593).
• Rework hook output to remove the table (#611).
• Switch to storing AST nodes on the stack for more accurate method signature check and easy access to parent nodes (#623).

Bug Fixes

• MAINT: Changed class constructor init GL08 reporting (#592).
• BUG: Correct functionality of numpydoc SS05 (#613).
• Specity the types of numpydoc_xref_ignore option (#631).

Documentation

• DOC: Do not use types for *args, **kwargs (#585).
• mention conda-forge in installation docs (#595).
• Fix typo in validation.rst (#605).
• Fix broken link in format.rst (#628).

Maintenance

• CI: use hashes for actions' versions in publishing job (#579).
• Bump the actions group with 2 updates (#581).
• Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.2 in the actions group (#582).
• [pre-commit.ci] pre-commit autoupdate (#583).
• MAINT: Add _exception_on_warning to MockApp (#586).
• Bump the actions group across 1 directory with 2 updates (#590).
• don't pass maxsplit as positional arg (#596).
• [pre-commit.ci] pre-commit autoupdate (#598).
• Add Python 3.13 support (#599).
• Update readthedocs config (#600).
• Bump the actions group with 2 updates (#603).
• Bump the actions group with 3 updates (#609).
• [pre-commit.ci] pre-commit autoupdate (#614).
• Bump actions/download-artifact from 4.2.1 to 4.3.0 in the actions group (#620).
• Bump scientific-python/circleci-artifacts-redirector-action from 1.0.0 to 1.1.0 in the actions group (#627).
• Switch to dependency groups (#626).
• Fix pip setup command in github workflow (#629).

Contributors

13 authors added to this release (alphabetically):

• Brigitta Sipőcz (@bsipocz)
• Daniel McCloy (@drammock)
• Eric Larson (@larsoner)
• Gilles Peiffer (@Peiffap)
• Jarrod Millman (@jarrodmillman)
• Lucas Colley (@lucascolley)
• Matt Gebert (@mattgebert)
• Maxine Hartnett (@maxinelasp)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)
• Stefanie Molin (@stefmolin)
• Tim Hoffmann (@timhoffm)
• Yuki Kobayashi (@koyuki7w)

7 reviewers added to this release (alphabetically):

• Charles Harris (@charris)
• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• Lucas Colley (@lucascolley)
• Matt Gebert (@mattgebert)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)

These lists are automatically generated, and may not be complete or may contain duplicates.

1.8.0

We're happy to announce the release of numpydoc 1.8.0!

Enhancements

• Unify CLIs (#537).
• Move "Attributes" and "Methods" below "Parameters" (#571).

Bug Fixes

• FIX: coroutines can have a return statement (#542).
• Unwrap decorated objects for YD01 validation check (#541).
• Fix bug with validation encoding (#550).

Documentation

• Classify development status as Production/Stable (#548).
• Add note about TOML regex; fix typo (#552).
• DOC: Clarify recommendations regarding use of backticks (#525).

Maintenance

• Fix typo in label-check.yml (#538).
• [pre-commit.ci] pre-commit autoupdate (#539).
• DEV: Rm xfails from pytest summary (#540).
• Drop Python 3.8 support (#545).
• Clean up old sphinx cruft (#549).
• Test on sphinx 7.3 (#547).
• Require GHA update grouping (#553).
• Update pre-commit config (#554).
• Use ruff for linting and formatting (#555).
• Use intersphinx registry to avoid out of date links (#563).
• Do not rely on requirements.txt in ci, use .[test,doc] (#566).
• CI: update action that got moved org (#567).
• Fix navbar for documentation pages (#569).
• [pre-commit.ci] pre-commit autoupdate (#570).
• docscrape: fixes from SciPy (#576).
• MAINT: Remove scale to work around PyPI bug (#578).

Contributors

10 authors added to this release (alphabetically):

• Brigitta Sipőcz (@bsipocz)
• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• Lucas Colley (@lucascolley)
• M Bussonnier (@Carreau)
• Matt Haberland (@mdhaber)
• Melissa Weber Mendonça (@melissawm)
• Ross Barnowski (@rossbar)
• Stefanie Molin (@stefmolin)
• Thomas A Caswell (@tacaswell)

7 reviewers added to this release (alphabetically):

• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• M Bussonnier (@Carreau)
• Matt Haberland (@mdhaber)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)
• Stefanie Molin (@stefmolin)

These lists are automatically generated, and may not be complete or may contain duplicates.

1.8.0rc2

We're happy to announce the release of numpydoc 1.8.0rc2!

Enhancements

• Unify CLIs (#537).
• Move "Attributes" and "Methods" below "Parameters" (#571).

Bug Fixes

• FIX: coroutines can have a return statement (#542).
• Unwrap decorated objects for YD01 validation check (#541).
• Fix bug with validation encoding (#550).

Documentation

• Classify development status as Production/Stable (#548).
• Add note about TOML regex; fix typo (#552).
• DOC: Clarify recommendations regarding use of backticks (#525).

Maintenance

• Fix typo in label-check.yml (#538).
• [pre-commit.ci] pre-commit autoupdate (#539).
• DEV: Rm xfails from pytest summary (#540).
• Drop Python 3.8 support (#545).
• Clean up old sphinx cruft (#549).
• Test on sphinx 7.3 (#547).
• Require GHA update grouping (#553).
• Update pre-commit config (#554).
• Use ruff for linting and formatting (#555).
• Use intersphinx registry to avoid out of date links (#563).
• Do not rely on requirements.txt in ci, use .[test,doc] (#566).
• CI: update action that got moved org (#567).
• Fix navbar for documentation pages (#569).
• [pre-commit.ci] pre-commit autoupdate (#570).
• docscrape: fixes from SciPy (#576).
• MAINT: Remove scale to work around PyPI bug (#578).

Contributors

10 authors added to this release (alphabetically):

• Brigitta Sipőcz (@bsipocz)
• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• Lucas Colley (@lucascolley)
• M Bussonnier (@Carreau)
• Matt Haberland (@mdhaber)
• Melissa Weber Mendonça (@melissawm)
• Ross Barnowski (@rossbar)
• Stefanie Molin (@stefmolin)
• Thomas A Caswell (@tacaswell)

7 reviewers added to this release (alphabetically):

• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• M Bussonnier (@Carreau)
• Matt Haberland (@mdhaber)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)
• Stefanie Molin (@stefmolin)

These lists are automatically generated, and may not be complete or may contain duplicates.

1.8.0rc1

We're happy to announce the release of numpydoc 1.8.0rc1!

Enhancements

• Unify CLIs (#537).
• Move "Attributes" and "Methods" below "Parameters" (#571).

Bug Fixes

• FIX: coroutines can have a return statement (#542).
• Unwrap decorated objects for YD01 validation check (#541).
• Fix bug with validation encoding (#550).

Documentation

• Classify development status as Production/Stable (#548).
• Add note about TOML regex; fix typo (#552).
• DOC: Clarify recommendations regarding use of backticks (#525).

Maintenance

• Fix typo in label-check.yml (#538).
• [pre-commit.ci] pre-commit autoupdate (#539).
• DEV: Rm xfails from pytest summary (#540).
• Drop Python 3.8 support (#545).
• Clean up old sphinx cruft (#549).
• Test on sphinx 7.3 (#547).
• Require GHA update grouping (#553).
• Update pre-commit config (#554).
• Use ruff for linting and formatting (#555).
• Use intersphinx registry to avoid out of date links (#563).
• Do not rely on requirements.txt in ci, use .[test,doc] (#566).
• CI: update action that got moved org (#567).
• Fix navbar for documentation pages (#569).
• [pre-commit.ci] pre-commit autoupdate (#570).
• docscrape: fixes from SciPy (#576).

Contributors

10 authors added to this release (alphabetically):

• Brigitta Sipőcz (@bsipocz)
• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• Lucas Colley (@lucascolley)
• M Bussonnier (@Carreau)
• Matt Haberland (@mdhaber)
• Melissa Weber Mendonça (@melissawm)
• Ross Barnowski (@rossbar)
• Stefanie Molin (@stefmolin)
• Thomas A Caswell (@tacaswell)

7 reviewers added to this release (alphabetically):

• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• M Bussonnier (@Carreau)
• Matt Haberland (@mdhaber)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)
• Stefanie Molin (@stefmolin)

These lists are automatically generated, and may not be complete or may contain duplicates.

1.7.0

We're happy to announce the release of numpydoc 1.7.0!

Enhancements

• PERF: wrap inspect.getsourcelines with cache (#532).

Bug Fixes

• during tokenize, use UTF8 encoding on all platforms (#510).
• fix 'Alias for field number X' problem with NamedTuples (#527).

Documentation

• DOC: Fix typos found by codespell (#514).
• DOC: Update link to mailing list (#518).
• Add Python 3.12 to classifiers (#529).
• Update release process (#534).
• Update release process (#535).

Maintenance

• [pre-commit.ci] pre-commit autoupdate (#508).
• [pre-commit.ci] pre-commit autoupdate (#513).
• MAINT: apply refurb suggestion (#515).
• [pre-commit.ci] pre-commit autoupdate (#516).
• Bump actions/setup-python from 4 to 5 (#520).
• [pre-commit.ci] pre-commit autoupdate (#521).
• Filter DeprecationWarning in failing test for python 3.12 (#523).
• MAINT: Replace NameConstant with Constant (#524).
• [pre-commit.ci] pre-commit autoupdate (#526).
• Update precommit repos (#531).
• Require sphinx 6 (#530).
• Use trusted publisher (#533).

Contributors

8 authors added to this release (alphabetically):

• Chiara Marmo (@cmarmo)
• Daniel McCloy (@drammock)
• Dimitri Papadopoulos Orfanos (@DimitriPapadopoulos)
• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• Niko Föhr (@fohrloop)
• Philipp Hoffmann (@dontgoto)
• Ross Barnowski (@rossbar)

9 reviewers added to this release (alphabetically):

• Antoine Pitrou (@pitrou)
• Charles Harris (@charris)
• Daniel McCloy (@drammock)
• Eric Larson (@larsoner)
• GitHub Web Flow (@web-flow)
• Jarrod Millman (@jarrodmillman)
• Niko Föhr (@fohrloop)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)

These lists are automatically generated, and may not be complete or may contain duplicates.

1.7.0rc0

We're happy to announce the release of numpydoc 1.7.0rc0!

Enhancements

• PERF: wrap inspect.getsourcelines with cache (#532).

Bug Fixes

• during tokenize, use UTF8 encoding on all platforms (#510).
• fix 'Alias for field number X' problem with NamedTuples (#527).

Documentation

• DOC: Fix typos found by codespell (#514).
• DOC: Update link to mailing list (#518).
• Add Python 3.12 to classifiers (#529).

Maintenance

• [pre-commit.ci] pre-commit autoupdate (#508).
• [pre-commit.ci] pre-commit autoupdate (#513).
• MAINT: apply refurb suggestion (#515).
• [pre-commit.ci] pre-commit autoupdate (#516).
• Bump actions/setup-python from 4 to 5 (#520).
• [pre-commit.ci] pre-commit autoupdate (#521).
• Filter DeprecationWarning in failing test for python 3.12 (#523).
• MAINT: Replace NameConstant with Constant (#524).
• [pre-commit.ci] pre-commit autoupdate (#526).
• Update precommit repos (#531).
• Require sphinx 6 (#530).
• Use trusted publisher (#533).

Contributors

8 authors added to this release (alphabetically):

• Chiara Marmo (@cmarmo)
• Daniel McCloy (@drammock)
• Dimitri Papadopoulos Orfanos (@DimitriPapadopoulos)
• Eric Larson (@larsoner)
• Jarrod Millman (@jarrodmillman)
• Niko Föhr (@fohrloop)
• Philipp Hoffmann (@dontgoto)
• Ross Barnowski (@rossbar)

9 reviewers added to this release (alphabetically):

• Antoine Pitrou (@pitrou)
• Charles Harris (@charris)
• Daniel McCloy (@drammock)
• Eric Larson (@larsoner)
• GitHub Web Flow (@web-flow)
• Jarrod Millman (@jarrodmillman)
• Niko Föhr (@fohrloop)
• Ross Barnowski (@rossbar)
• Stefan van der Walt (@stefanv)

These lists are automatically generated, and may not be complete or may contain duplicates.

1.6.0

Release date: 21 August 2023

Requires Python 3.8+ and Sphinx 5+.

Full Changelog

Closed issues

• numpydoc ignore inline comment not recognized when using decorators #495
• Align pre-commit and Sphinx rule override syntax #466
• Use pyproject.toml #473
• rtd is failing #471
• circleci-artifacts-redirector-action error #469
• Incorporate a pre-commit hook for numpydoc validation #450
• PR06 fails when offending type name is used only as a substring #446
• style of [1] is strange in numpydoc docs #443
• Double click on function parameter selects parameter type as well #427

Merged pull requests

• Bump actions/checkout from 3 to 4 #504 (dependabot[bot])
• [pre-commit.ci] pre-commit autoupdate #501 (pre-commit-ci[bot])
• BUG: validator now handles properties #500 (sdiebolt)
• Fix clean_backref for extensions that have backrefs to inline elements. #499 (mcmtroffaes)
• BUG: validator now handles decorators #496 (sdiebolt)
• TST: Test no-file for source #493 (larsoner)
• Use label-check and attach-next-milestone-action #492 (jarrodmillman)
• Remove old linter check (using precommit bot now) #491 (jarrodmillman)
• Update pydata-sphinx-theme #490 (jarrodmillman)
• Use dependabot to update actions #489 (jarrodmillman)
• Add config for pre-commit bot #488 (jarrodmillman)
• Update pre-commits #487 (jarrodmillman)
• Sync updates to generate_requirements.py from scikit-image #485 (mwtoews)
• Generate requirements files from pyproject.toml #483 (mwtoews)
• Add Source to project.urls table #480 (mwtoews)
• Align behavior of pre-commit hook and Sphinx extension #476 (stefmolin)
• Fix dynamic version specification. #477 (stefmolin)
• Update year #475 (jarrodmillman)
• Use pyproject.toml #474 (jarrodmillman)
• Install package on rtd #472 (jarrodmillman)
• Add token for artifact redirector #470 (jarrodmillman)
• Use rtd template (old method is deprecated) #468 (jarrodmillman)
• Update doc requirements #465 (jarrodmillman)
• Update pre-commit hooks #464 (jarrodmillman)
• Drop Python 3.7 #462 (jarrodmillman)
• Require Sphinx 5+ #461 (jarrodmillman)
• Pre-commit hook for running numpydoc validation #454 (stefmolin)
• MAINT: Compatibility with pydata-sphinx-theme #453 (larsoner)
• MAINT: Refactoring get_doc_object #452 (F3eQnxN3RriK)
• Update blacken-docs repo after owner transfer. #451 (stefmolin)
• Update pre-commit #449 (jarrodmillman)
• MAINT: Fix CIs for sphinx 6 #448 (larsoner)
• Change PR06 logic to only fail when type is used standalone #447 (amoeba)
• Fix release notes #442 (jarrodmillman)

* This Changelog was automatically generated by
github_changelog_generator

What's Changed

• DOC: Add theme switcher and default to lightmode. by @rossbar in #414
• Update GH actions by @jarrodmillman in #416
• ENH: Add support for dict show_inherited_class_members by @larsoner in #415
• Update precommit linters by @jarrodmillman in #417
• docs: fix validation include line numbers by @thatlittleboy in #418
• Require sphinx>=4.2 by @jarrodmillman in #411
• Require sphinx>=4.2 (cleanup) by @jarrodmillman in #421
• Remove numpydoc_use_blockquotes by @jarrodmillman in #422
• DOC: Use :ref: when referring to section headers by @namurphy in #424
• ENH: Update validate.py to allow parameters with trailing underscores. by @stefmolin in #425
• BUG: Fix returns parsing no name by @rossbar in #429
• Use requirements/*.txt files for CI by @jarrodmillman in #435
• Use Python 3.10 to build docs by @jarrodmillman in #436
• Update precommit hooks by @jarrodmillman in #437
• Add cached property support by @rossbar in #433
• Fix front page by @jarrodmillman in #434
• Support Python 3.11 by @jarrodmillman in #438
• Update pydata-sphinx-theme by @jarrodmillman in #440
• Update doc requirements by @jarrodmillman in #441

New Contributors

• @thatlittleboy made their first contribution in #418
• @namurphy made their first contribution in #424
• @stefmolin made their first contribution in #425

Full Changelog: v1.4.0...v1.5.0

What's Changed

• DOC: Add theme switcher and default to lightmode. by @rossbar in #414
• Update GH actions by @jarrodmillman in #416
• ENH: Add support for dict show_inherited_class_members by @larsoner in #415
• Update precommit linters by @jarrodmillman in #417
• docs: fix validation include line numbers by @thatlittleboy in #418
• Require sphinx>=4.2 by @jarrodmillman in #411
• Require sphinx>=4.2 (cleanup) by @jarrodmillman in #421
• Remove numpydoc_use_blockquotes by @jarrodmillman in #422
• DOC: Use :ref: when referring to section headers by @namurphy in #424
• ENH: Update validate.py to allow parameters with trailing underscores. by @stefmolin in #425
• BUG: Fix returns parsing no name by @rossbar in #429
• Use requirements/*.txt files for CI by @jarrodmillman in #435
• Use Python 3.10 to build docs by @jarrodmillman in #436
• Update precommit hooks by @jarrodmillman in #437
• Add cached property support by @rossbar in #433
• Fix front page by @jarrodmillman in #434
• Support Python 3.11 by @jarrodmillman in #438

New Contributors

• @thatlittleboy made their first contribution in #418
• @namurphy made their first contribution in #424
• @stefmolin made their first contribution in #425

Full Changelog: v1.4.0...v1.5.0rc1

What's Changed

• Use black by @jarrodmillman in #391
• Ignore black formatting by @jarrodmillman in #394
• Test on 3.11 by @jarrodmillman in #375
• Update pre-commit by @jarrodmillman in #396
• Cleanup sphinx conf by @jarrodmillman in #397
• Remove old warning filters by @jarrodmillman in #398
• Fix bug with version name by @jarrodmillman in #400
• Test prereleases of requirements by @jarrodmillman in #395
• Add workaround for pytest failures on 3.11b2 by @jarrodmillman in #404
• Use node.findall if available (docutils 18.x) by @drammock in #403
• Test docutils 0.18.1 by @jarrodmillman in #402
• Update GH actions by @jarrodmillman in #406
• Fix CI by @jarrodmillman in #410
• Remove pytest py3.11b2 workaround by @jarrodmillman in #407

New Contributors

• @drammock made their first contribution in #403

Full Changelog: v1.3.1...v1.4.0