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: