Recent Releases of numpydoc
numpydoc - v1.9.0
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_ignoreoption (#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 exceptionon_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.
- Python
Published by jarrodmillman about 1 year ago
numpydoc - v1.8.0
1.8.0
We're happy to announce the release of numpydoc 1.8.0!
Enhancements
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.
- 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.
- Python
Published by jarrodmillman almost 2 years ago
numpydoc - v1.8.0rc2
1.8.0rc2
We're happy to announce the release of numpydoc 1.8.0rc2!
Enhancements
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.
- 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.
- Python
Published by jarrodmillman almost 2 years ago
numpydoc - v1.8.0rc1
1.8.0rc1
We're happy to announce the release of numpydoc 1.8.0rc1!
Enhancements
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.
- 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.
- Python
Published by jarrodmillman almost 2 years ago
numpydoc - v1.7.0
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
DeprecationWarningin 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.
- Python
Published by jarrodmillman over 2 years ago
numpydoc - v1.7.0rc0
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
DeprecationWarningin 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.
- Python
Published by jarrodmillman over 2 years ago
numpydoc - numpydoc 1.6.0
1.6.0
Release date: 21 August 2023
Requires Python 3.8+ and Sphinx 5+.
Closed issues
-
numpydoc ignoreinline 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 githubchangeloggenerator
- Python
Published by jarrodmillman almost 3 years ago
numpydoc - numpydoc 1.5.0
What's Changed
- DOC: Add theme switcher and default to lightmode. by @rossbar in https://github.com/numpy/numpydoc/pull/414
- Update GH actions by @jarrodmillman in https://github.com/numpy/numpydoc/pull/416
- ENH: Add support for dict showinheritedclass_members by @larsoner in https://github.com/numpy/numpydoc/pull/415
- Update precommit linters by @jarrodmillman in https://github.com/numpy/numpydoc/pull/417
- docs: fix validation include line numbers by @thatlittleboy in https://github.com/numpy/numpydoc/pull/418
- Require sphinx>=4.2 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/411
- Require sphinx>=4.2 (cleanup) by @jarrodmillman in https://github.com/numpy/numpydoc/pull/421
- Remove numpydocuseblockquotes by @jarrodmillman in https://github.com/numpy/numpydoc/pull/422
- DOC: Use
:ref:when referring to section headers by @namurphy in https://github.com/numpy/numpydoc/pull/424 - ENH: Update validate.py to allow parameters with trailing underscores. by @stefmolin in https://github.com/numpy/numpydoc/pull/425
- BUG: Fix returns parsing no name by @rossbar in https://github.com/numpy/numpydoc/pull/429
- Use requirements/*.txt files for CI by @jarrodmillman in https://github.com/numpy/numpydoc/pull/435
- Use Python 3.10 to build docs by @jarrodmillman in https://github.com/numpy/numpydoc/pull/436
- Update precommit hooks by @jarrodmillman in https://github.com/numpy/numpydoc/pull/437
- Add cached property support by @rossbar in https://github.com/numpy/numpydoc/pull/433
- Fix front page by @jarrodmillman in https://github.com/numpy/numpydoc/pull/434
- Support Python 3.11 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/438
- Update pydata-sphinx-theme by @jarrodmillman in https://github.com/numpy/numpydoc/pull/440
- Update doc requirements by @jarrodmillman in https://github.com/numpy/numpydoc/pull/441
New Contributors
- @thatlittleboy made their first contribution in https://github.com/numpy/numpydoc/pull/418
- @namurphy made their first contribution in https://github.com/numpy/numpydoc/pull/424
- @stefmolin made their first contribution in https://github.com/numpy/numpydoc/pull/425
Full Changelog: https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0
- Python
Published by jarrodmillman almost 4 years ago
numpydoc - numpydoc 1.5.0rc1
What's Changed
- DOC: Add theme switcher and default to lightmode. by @rossbar in https://github.com/numpy/numpydoc/pull/414
- Update GH actions by @jarrodmillman in https://github.com/numpy/numpydoc/pull/416
- ENH: Add support for dict showinheritedclass_members by @larsoner in https://github.com/numpy/numpydoc/pull/415
- Update precommit linters by @jarrodmillman in https://github.com/numpy/numpydoc/pull/417
- docs: fix validation include line numbers by @thatlittleboy in https://github.com/numpy/numpydoc/pull/418
- Require sphinx>=4.2 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/411
- Require sphinx>=4.2 (cleanup) by @jarrodmillman in https://github.com/numpy/numpydoc/pull/421
- Remove numpydocuseblockquotes by @jarrodmillman in https://github.com/numpy/numpydoc/pull/422
- DOC: Use
:ref:when referring to section headers by @namurphy in https://github.com/numpy/numpydoc/pull/424 - ENH: Update validate.py to allow parameters with trailing underscores. by @stefmolin in https://github.com/numpy/numpydoc/pull/425
- BUG: Fix returns parsing no name by @rossbar in https://github.com/numpy/numpydoc/pull/429
- Use requirements/*.txt files for CI by @jarrodmillman in https://github.com/numpy/numpydoc/pull/435
- Use Python 3.10 to build docs by @jarrodmillman in https://github.com/numpy/numpydoc/pull/436
- Update precommit hooks by @jarrodmillman in https://github.com/numpy/numpydoc/pull/437
- Add cached property support by @rossbar in https://github.com/numpy/numpydoc/pull/433
- Fix front page by @jarrodmillman in https://github.com/numpy/numpydoc/pull/434
- Support Python 3.11 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/438
New Contributors
- @thatlittleboy made their first contribution in https://github.com/numpy/numpydoc/pull/418
- @namurphy made their first contribution in https://github.com/numpy/numpydoc/pull/424
- @stefmolin made their first contribution in https://github.com/numpy/numpydoc/pull/425
Full Changelog: https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0rc1
- Python
Published by jarrodmillman almost 4 years ago
numpydoc - numpydoc 1.4.0
What's Changed
- Use black by @jarrodmillman in https://github.com/numpy/numpydoc/pull/391
- Ignore black formatting by @jarrodmillman in https://github.com/numpy/numpydoc/pull/394
- Test on 3.11 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/375
- Update pre-commit by @jarrodmillman in https://github.com/numpy/numpydoc/pull/396
- Cleanup sphinx conf by @jarrodmillman in https://github.com/numpy/numpydoc/pull/397
- Remove old warning filters by @jarrodmillman in https://github.com/numpy/numpydoc/pull/398
- Fix bug with version name by @jarrodmillman in https://github.com/numpy/numpydoc/pull/400
- Test prereleases of requirements by @jarrodmillman in https://github.com/numpy/numpydoc/pull/395
- Add workaround for pytest failures on 3.11b2 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/404
- Use node.findall if available (docutils 18.x) by @drammock in https://github.com/numpy/numpydoc/pull/403
- Test docutils 0.18.1 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/402
- Update GH actions by @jarrodmillman in https://github.com/numpy/numpydoc/pull/406
- Fix CI by @jarrodmillman in https://github.com/numpy/numpydoc/pull/410
- Remove pytest py3.11b2 workaround by @jarrodmillman in https://github.com/numpy/numpydoc/pull/407
New Contributors
- @drammock made their first contribution in https://github.com/numpy/numpydoc/pull/403
Full Changelog: https://github.com/numpy/numpydoc/compare/v1.3.1...v1.4.0
- Python
Published by jarrodmillman about 4 years ago
numpydoc - numpydoc 1.4rc1
What's Changed
- Use black by @jarrodmillman in https://github.com/numpy/numpydoc/pull/391
- Ignore black formatting by @jarrodmillman in https://github.com/numpy/numpydoc/pull/394
- Test on 3.11 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/375
- Update pre-commit by @jarrodmillman in https://github.com/numpy/numpydoc/pull/396
- Cleanup sphinx conf by @jarrodmillman in https://github.com/numpy/numpydoc/pull/397
- Remove old warning filters by @jarrodmillman in https://github.com/numpy/numpydoc/pull/398
- Fix bug with version name by @jarrodmillman in https://github.com/numpy/numpydoc/pull/400
- Test prereleases of requirements by @jarrodmillman in https://github.com/numpy/numpydoc/pull/395
- Add workaround for pytest failures on 3.11b2 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/404
- Use node.findall if available (docutils 18.x) by @drammock in https://github.com/numpy/numpydoc/pull/403
- Test docutils 0.18.1 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/402
- Update GH actions by @jarrodmillman in https://github.com/numpy/numpydoc/pull/406
New Contributors
- @drammock made their first contribution in https://github.com/numpy/numpydoc/pull/403
Full Changelog: https://github.com/numpy/numpydoc/compare/v1.3.1...v1.4.0rc1
- Python
Published by jarrodmillman about 4 years ago
numpydoc - numpydoc 1.3.1
What's Changed
- Update doc requirements by @jarrodmillman in https://github.com/numpy/numpydoc/pull/389
- Update manifest by @jarrodmillman in https://github.com/numpy/numpydoc/pull/388
Full Changelog: https://github.com/numpy/numpydoc/compare/v1.3.0...v1.3.1
- Python
Published by jarrodmillman about 4 years ago
numpydoc - numpydoc 1.3.0
Requires Python 3.7+ and Sphinx 3.0+.
What's Changed
- Remove deprecated numpydoceditlink by @jarrodmillman in https://github.com/numpy/numpydoc/pull/372
- Cleanup cruft by @jarrodmillman in https://github.com/numpy/numpydoc/pull/371
- Add pre-commit hook / linter by @jarrodmillman in https://github.com/numpy/numpydoc/pull/374
- DOC: fix broken link to built-in validation checks. by @rossbar in https://github.com/numpy/numpydoc/pull/379
- Runtime verification of sphinx and jinja2 versions by @rossbar in https://github.com/numpy/numpydoc/pull/381
- MAINT: Dont import for version by @larsoner in https://github.com/numpy/numpydoc/pull/382
- Update tests + coverage config to rm warnings. by @rossbar in https://github.com/numpy/numpydoc/pull/383
- Require sphinx>3 by @jarrodmillman in https://github.com/numpy/numpydoc/pull/385
Full Changelog: https://github.com/numpy/numpydoc/compare/v1.2.1...v1.3.0
- Python
Published by jarrodmillman about 4 years ago
numpydoc - numpydoc 1.2.1
Requires Python 3.7+ and Sphinx 1.8+.
Implemented enhancements
- Update year #370 (jarrodmillman)
Fixed bugs
- Use consistent release tags #361 (jarrodmillman)
- BUG: 1.2 raises error w.r.t. object has no attribute
__name__#362 - Use isgeneratorfunction to avoid false alarm YD01 validation #368 (jnothman)
- Fix AttributeError in underline length check #363 (rossbar)
- Upper bound jinja #369 (jarrodmillman)
Closed issues
- Validation check YD01 not implemented properly #365
- Support numpydoc validation without running sphinx #364
- 1.2: change tagging convention? #360
- Python
Published by jarrodmillman over 4 years ago
numpydoc - numpydoc 1.2.0
Requires Python 3.7+ and Sphinx 1.8+.
Implemented enhancements
- Document release process #357 (jarrodmillman)
- Use setuptools #349 (jarrodmillman)
- DOC: Switch docs to pydata-sphinx-theme #313 (rossbar)
- Improve error messages for see also parsing #306 (rossbar)
- ENH: Enable validation during sphinx-build process #302 (rossbar)
- Add a note to the docstring standard about long 'See Also' entries. #300 (WarrenWeckesser)
- MAINT: minor refactoring in docscrape #297 (rossbar)
- ENH: Add configuration option for parameter cross-referencing #295 (rossbar)
- ENH: Better warning for sections. #278 (Carreau)
Fixed bugs
- How to specify that parameter can equal the string 'integer'? #341
- Fix validation bug when parameter type is set of options. #347 (rossbar)
- Escape newline in docstring. #345 (Carreau)
- Correctly validate parameters under the "Other Parameters" section #337 (dcbr)
- BUG: fix an incomplete check in
Reader.\_error\_location#308 (rgommers) - MAINT: pytest ignore doc directory. #296 (rossbar)
- DOC: fix inaccuracy in validate docstring. #294 (rossbar)
- Fix param parsing. #286 (Carreau)
- BUG: Properly parse See Also when summary on first line. #283 (Carreau)
- BUG: fix role regex. #280 (Carreau)
- fix splitting of parameter lines. #279 (Carreau)
Closed issues
- Class methods (\@classmethod) are not documented using
numpydoc#340 - Exclude certain methods from METHODS section #338
- Warnings is not allowed in "GL06" check #334
- Add version to style guide #333
- numpydoc does not render parameters as expected #329
- 1.1.0: pytest warnings #324
- RTD configuration -
latest#321 - Rendering of types in latest doc build #318
- Anchors for individual sections in numpydoc doc? #317
- Development documentation not up-to-date #311
- Warning: autosummary: stub file not found #290
- Wrong number of Parameter for numpy array. #285
- syntax to document default values #284
- Failed See Also Parsing. #281
- Sphinx emits "WARNING: py:class reference target not found" with numpydoc 1.1.0 #275
- Python
Published by jarrodmillman over 4 years ago
numpydoc - numpydoc 1.1.0
Implemented enhancements
- MAINT: Suggestions from reviewing test suite
#271 <https://github.com/numpy/numpydoc/pull/271>__ (rossbar <https://github.com/rossbar>__) - DEV: Add testing requirements
#267 <https://github.com/numpy/numpydoc/pull/267>__ (rossbar <https://github.com/rossbar>__) - BUG: Defer to autodoc for signatures
#221 <https://github.com/numpy/numpydoc/pull/221>__ (thequackdaddy <https://github.com/thequackdaddy>__)
Fixed bugs
- function signatures for *args, **kwargs objects off
#218 <https://github.com/numpy/numpydoc/issues/218>__ - BUG: Connect to earlier event
#269 <https://github.com/numpy/numpydoc/pull/269>__ (larsoner <https://github.com/larsoner>__)
Closed issues
- “Handler
for event ‘autodoc-process-docstring’ threw an exception” #268 <https://github.com/numpy/numpydoc/issues/268>__ - Timing of next release
#249 <https://github.com/numpy/numpydoc/issues/249>__ - self included in list of params for method
#220 <https://github.com/numpy/numpydoc/issues/220>__
Additional notes
- Due to merging of
#221 <https://github.com/numpy/numpydoc/pull/221>__, self and cls no longer will appear in method signatures.
- Python
Published by larsoner about 6 years ago
numpydoc - numpydoc 1.0.0
Implemented enhancements:
- ENH: Add args and kwargs to example #258 (larsoner)
- MAINT,STY: Upgrade to bionic, and change style similar to NumPy #253 (mwtoews)
- Delay import of Sphinx #248 (cgohlke)
- Adding --validate option __main_ and run new validation #240 (datapythonista)
- Add docstring validation script (from pandas) #238 (datapythonista)
- ENH: Test full output and coverage #230 (larsoner)
- DOC: Add description for blank lines after the docstring. #229 (bingyao)
Fixed bugs
- References outside function #214
- FIX: Get doc of actual class in test #262 (larsoner)
- TST: Add inherited method #260 (larsoner)
- Fixes references outside function (#214) #259 (Hoxbro)
- Disable escaping "*" on signature #256 (tk0miya)
- MAINT: clean-up unused objects #254 (mwtoews)
- STY: Reword first lines of example.py docstrings #246 (justinludwig)
- DOC: Fixed three formatting issues in docs #245 (rossbar)
- STY Minor style improvements to doc/example.py to pass validation #243 (rth)
- BUG: Allow no . at end if indented #239 (larsoner)
- DOC: Update links and code checkers info in format.rst #228 (bingyao)
- DOC: Update links and info in conf.py. #227 (bingyao)
- BUG: Fix full rebuilds #226 (larsoner)
- MAINT: doctest and pytest #225 (larsoner)
- Py3fy some doctests. #224 (anntzer)
- MAINT: fix trivial source comment typos #222 (luzpaz)
- Add missing headings to code examples #252 (Cadair)
Removed
Closed issues
- Prefix added to reference keys in class docstrings #263
- Test failure with python 3.9 #261
- sphinx doc napoleon extension maintainer interest request #251
- Missing reference to float_power function in the ufunc list #250
Additional notes
- CSS styling changed from NumpyDoc < 0.8 and Sphinx < 2.0 to more properly make use of definition lists. This can cause issues with rendering that can be fixed via CSS, especially when using
sphinx-rtd-theme. For more information, see:
- Python
Published by larsoner about 6 years ago
numpydoc - numpydoc 0.9.1
This is a bug fix release for 0.9.0 with only one change:
Merged pull requests: - Updating minimum sphinx version in setup.py #211
Closed issues: - AttributeError: 'module' object has no attribute 'getLogger' #210
- Python
Published by rgommers about 7 years ago
numpydoc - numpydoc 0.9.0
Implemented enhancements:
- MAINT: Add CircleCI #208 (larsoner)
- ENH: accept autoclass member options #205 (mattip)
- Clarify location of certain invalid docstrings. #200 (anntzer)
- ENH: Xref param type #197 (larsoner)
- Make parameter a namedtuple #176 (timhoffm)
- ENH: Added support for multiple functions+description in a See Also block #172 (pvanmulbregt)
- DOC: Added example of multi-line code in Examples section. #168 (pvanmulbregt)
- switch the test suite to pytest #166 (ev-br)
- Report object name upon mangle_docstrings exception #164 (jnothman)
- Add option to use member listing for attributes #161 jorisvandenbossche
- Require that sphinx issue no warnings in CI #153 (jnothman)
- Command-line tool to help debug NumpyDocString #146 (jnothman)
- Support Receives section for generator.send(...) params #145 (jnothman)
Fixed bugs:
- References messed up #177
- BUG?: References always have an errant second link #169
- BUG: turn member descriptor attributes into links #201 (mattip)
- FIX: Fix collections.abc imports #195 (larsoner)
- FIX: Escape chars in re #194 (larsoner)
- Fix markup in format.rst. #193 (anntzer)
- Move setup of autosummary earlier in setup(). #191 (anntzer)
- Only print the index if it is necessary. #187 (hmaarrfk)
- FIX pedantic handling of whitespace in reference regex #181 (jnothman)
- FIX remove duplicated citation back-references #180 (jnothman)
- Use DEDUPLICATION_TAG to determine whether a citation node is in a docstring #179 (jnothman)
- FIX parsing of type-only return params #175 (timhoffm)
- pip --use-wheel no longer exists #174 (jnothman)
- DOC: Add missing backslash to omega for inline math example. #171 (pvanmulbregt)
- DOC: remove links to numpy repo file #167 (mattip)
- Escape the * in *args and **kwargs #155 (has2k1)
Closed issues:
- autosummary fails with numpydoc where napoleon succeeds #204
- NumpyDocString doesn't roundtrip well #188
- Generating a docstring from a numpydoc object #186
- make parameters and attributes anchors in docstrings #185
- BUG: Plot(s) not rendered if docstring ends with normal text after show command #162
- Location reporting returns useless information #115
- Anonymous return values have their types populated in the name slot of the tuple. #72
- support for coroutine #47
- multiple entries in a See Also section #28
- Python
Published by rgommers about 7 years ago