numpydoc 1.2.0
·
201 commits
to main
since this release
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