Please release a new version

[henry0312]

There has not been a new release for about a year.
https://github.com/numpy/numpydoc/releases

[jnothman]

This looks like a good idea. @pv, @rgommers?

[rgommers]

That makes sense to me. I probably could do that towards the end of this week.

@jnothman there's a number of PRs open that look useful, mainly from you. No one else unfortunately had much bandwidth to review. Would it make sense to merge some of those before a new release? I can try to look at the most important ones.

[jnothman]

So are we okay to push this out as it is? Do we need to throw together a change log?

[larsoner]

So are we okay to push this out as it is?

It would be good to get in #161 and #164 before pushing out a release.

Do we need to throw together a change log?

It would be nice to do this for people. I ran:

$ github_changelog_generator numpy/numpydoc --unreleased-only

And saw a lot of PRs in the category "Merged pull requests", so I took 10 min to label the merged PRs, re-ran, and now get something that can probably be copy-pasted/adjusted to give something usable without too much more work:

---

Change Log

Unreleased

Full Changelog

Implemented enhancements:

• ENH: accept autoclass member options #205 (mattip)
• Clarify location of certain invalid docstrings. #200 (anntzer)
• 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)
• 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

[jorisvandenbossche]

It would be good to get in #161 and #164 before pushing out a release.

I will try to get to #161 this evening or tomorrow (and also try to build the pandas docs with numpydoc master)

[jorisvandenbossche]

Updated the PR, and tested numpydoc master with the pandas docs. This seems to go fine (apart from a few cases where numpydoc got stricter in parsing the See Also, but those were actual mistakes in our docs)

[rgommers]

0.9.0 is up, closing. thanks all for getting all PRs in!

[rgommers]

question: should be make the next version number 0.10.0 or 1.0.0?

[larsoner]

I'm fine with either. If forced to choose I'd go with 1.0.0

[rgommers]

@larsoner apologies, I overlooked your Changelog. That still looks useful to put on https://github.com/numpy/numpydoc/releases/tag/v0.9.0 and send out to the mailing list. I'll see if I can add the last few PRs we merged.

EDIT: done now

[jnothman]

Thanks @rgommers for pulling it together. Sorry I was not more available at this point.

[rgommers]

@jnothman no worries at all - you and @larsoner did most of the heavy lifting for this release!