Releases: numpy/numpydoc
Releases · numpy/numpydoc
numpydoc 1.3.1
v1.3.1
This tag was signed with the committer’s verified signature.
jarrodmillman
Jarrod Millman
What's Changed
- Update doc requirements by @jarrodmillman in #389
- Update manifest by @jarrodmillman in #388
Full Changelog: v1.3.0...v1.3.1
Contributors
jarrodmillman
Assets 2
numpydoc 1.3.0
v1.3.0
This tag was signed with the committer’s verified signature.
jarrodmillman
Jarrod Millman
Requires Python 3.7+ and Sphinx 3.0+.
What's Changed
- Remove deprecated numpydoc_edit_link by @jarrodmillman in #372
- Cleanup cruft by @jarrodmillman in #371
- Add pre-commit hook / linter by @jarrodmillman in #374
- DOC: fix broken link to built-in validation checks. by @rossbar in #379
- Runtime verification of sphinx and jinja2 versions by @rossbar in #381
- MAINT: Dont import for version by @larsoner in #382
- Update tests + coverage config to rm warnings. by @rossbar in #383
- Require sphinx>3 by @jarrodmillman in #385
Full Changelog: v1.2.1...v1.3.0
Contributors
jarrodmillman, rossbar, and larsoner
Assets 2
numpydoc 1.3rc1
v1.3rc1
This tag was signed with the committer’s verified signature.
jarrodmillman
Jarrod Millman
v1.3rc1 signed 1.3rc1 tag
numpydoc 1.2.1
v1.2.1
This tag was signed with the committer’s verified signature.
jarrodmillman
Jarrod Millman
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
numpydoc 1.2.0
numpydoc-1.2
This tag was signed with the committer’s verified signature.
jarrodmillman
Jarrod Millman
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
Contributors
classmethod
Assets 2
numpydoc 1.2.0 release candidate 1
numpydoc-1.2rc1
This tag was signed with the committer’s verified signature.
jarrodmillman
Jarrod Millman
numpydoc-1.2rc1 signed 1.2rc1 tag
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 <function mangle_docstrings at 0x7f64b5ba57b8> 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.
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:
numpydoc 0.9.1
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