[Numpy-discussion] numpydoc 0.9.0 released

[Ralf Gommers]

And hopefully last update: 0.9.1 is now also released, with an update to
install_requires. Numpydoc now requires Sphinx >= 1.6.5



On Sun, Apr 21, 2019 at 9:35 PM Ralf Gommers <ralf.gommers at gmail.com> wrote:

>
>
> On Sun, Apr 21, 2019 at 9:01 PM Ralf Gommers <ralf.gommers at gmail.com>
> wrote:
>
>> Hi all,
>>
>> Numpydoc 0.9.0 was just released. Please see
>> https://github.com/numpy/numpydoc/milestone/4?closed=1 for a list of
>> included fixes and new features.
>>
>
> And I overlooked the Changelog that Eric Larson had already very helpfully
> prepared (sorry Eric!). Here it is:
>
> 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
>
>
> This Changelog with links to PRs and issues can be found at
> https://github.com/numpy/numpydoc/releases/tag/v0.9.0
>
> Cheers,
> Ralf
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20190423/fa10dafd/attachment.html>