Release notes#

Note

For release notes (sparsely) kept prior to 1.0.0, look at the releases page on GitHub.

1.3.1#

Release date: 30 April 2022

Requires Python 3.7+ and Sphinx 3.0+.

Full Changelog

Closed issues:

  • numpydoc-1.3.tar.gz on pypi is missing requirements/ needed by setup.py #387

  • What to do about Jinja2 dependency & supporting old sphinx versions #380

  • RFE: please update for jinja2 3.x #376

  • Test failures with Sphinx 4.5.0 #373

Merged pull requests:

1.3#

Release date: 29 April 2022

Requires Python 3.7+ and Sphinx 3.0+.

Full Changelog

Closed issues#

  • Broken “many checks” link in validation chapter #378

  • 1.2.1: pytest warnings #377

Merged pull requests#

1.2.1#

Release date: 29 March 2022

Requires Python 3.7+ and Sphinx 1.8+.

Full Changelog

Implemented enhancements#

Fixed bugs#

Closed issues#

  • Validation check YD01 not implemented properly #365

  • Support numpydoc validation without running sphinx #364

  • 1.2: change tagging convention? #360

1.2.0#

Release date: 24 January 2022

Requires Python 3.7+ and Sphinx 1.8+.

Implemented enhancements#

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

1.1.0#

Implemented enhancements#

Fixed bugs#

  • function signatures for *args, **kwargs objects off #218

  • BUG: Connect to earlier event #269 (larsoner)

Closed issues#

  • “Handler <function mangle_docstrings at 0x7f64b5ba57b8> for event ‘autodoc-process-docstring’ threw an exception” #268

  • Timing of next release #249

  • self included in list of params for method #220

Additional notes#

  • Due to merging of #221, self and cls no longer will appear in method signatures.

1.0.0#

Implemented enhancements#

Fixed bugs#

Removed#

  • MNT Drop Python 2.7 and 3.4 support #236 (rth)

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:

On this page
Show Source