search

rsokl / MyGrad

Drop-in autodiff for NumPy.
https://rsokl.github.io/MyGrad/
MIT License
195 stars 21 forks source link

Bump numpydoc from 1.1.0 to 1.5.0 in /docs #415

Closed dependabot[bot] closed 1 year ago

dependabot[bot] commented 1 year ago

Bumps numpydoc from 1.1.0 to 1.5.0.

Release notes

Sourced from numpydoc's releases.

numpydoc 1.2.0

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

... (truncated)

Changelog

Sourced from numpydoc's changelog.

1.5.0

Release date: 8 October 2022

Requires Python 3.7+ and Sphinx 4.2+.

Full Changelog <https://github.com/numpy/numpydoc/compare/v1.4.0...v1.5.0>__

Fixed bugs


-  Parsing ``returns`` section with several types and no name `[#428](https://github.com/numpy/numpydoc/issues/428) <https://github.com/numpy/numpydoc/issues/428>`__
-  BUG: Fix returns parsing no name `[#429](https://github.com/numpy/numpydoc/issues/429) <https://github.com/numpy/numpydoc/pull/429>`__ (`rossbar <https://github.com/rossbar>`__)

Closed issues

  • readthedocs build failing [#439](https://github.com/numpy/numpydoc/issues/439) <https://github.com/numpy/numpydoc/issues/439>__
  • Exclude class properties from being listed under METHODS section [#339](https://github.com/numpy/numpydoc/issues/339) <https://github.com/numpy/numpydoc/issues/339>__
  • BUG: Numpydoc doesn’t render attributes decorated with cached\_property in the Attributes section [#432](https://github.com/numpy/numpydoc/issues/432) <https://github.com/numpy/numpydoc/issues/432>__
  • Is numpydoc_use_blockquotes deprecated or not yet? [#420](https://github.com/numpy/numpydoc/issues/420) <https://github.com/numpy/numpydoc/issues/420>__
  • No light theme available in docs [#413](https://github.com/numpy/numpydoc/issues/413) <https://github.com/numpy/numpydoc/issues/413>__
  • 1.4.0 release plan [#408](https://github.com/numpy/numpydoc/issues/408) <https://github.com/numpy/numpydoc/issues/408>__

Merged pull requests


-  Update doc requirements `[#441](https://github.com/numpy/numpydoc/issues/441) <https://github.com/numpy/numpydoc/pull/441>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Update pydata-sphinx-theme `[#440](https://github.com/numpy/numpydoc/issues/440) <https://github.com/numpy/numpydoc/pull/440>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Support Python 3.11 `[#438](https://github.com/numpy/numpydoc/issues/438) <https://github.com/numpy/numpydoc/pull/438>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Update precommit hooks `[#437](https://github.com/numpy/numpydoc/issues/437) <https://github.com/numpy/numpydoc/pull/437>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Use Python 3.10 to build docs `[#436](https://github.com/numpy/numpydoc/issues/436) <https://github.com/numpy/numpydoc/pull/436>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Use `requirements/*.txt` files for CI `[#435](https://github.com/numpy/numpydoc/issues/435) <https://github.com/numpy/numpydoc/pull/435>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Fix front page `[#434](https://github.com/numpy/numpydoc/issues/434) <https://github.com/numpy/numpydoc/pull/434>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Add cached property support `[#433](https://github.com/numpy/numpydoc/issues/433) <https://github.com/numpy/numpydoc/pull/433>`__ (`rossbar <https://github.com/rossbar>`__)
-  ENH: Update validate.py to allow parameters with trailing underscores. `[#425](https://github.com/numpy/numpydoc/issues/425) <https://github.com/numpy/numpydoc/pull/425>`__ (`stefmolin <https://github.com/stefmolin>`__)
-  DOC: Use ``:ref:`` when referring to section headers `[#424](https://github.com/numpy/numpydoc/issues/424) <https://github.com/numpy/numpydoc/pull/424>`__ (`namurphy <https://github.com/namurphy>`__)
-  Remove numpydoc_use_blockquotes `[#422](https://github.com/numpy/numpydoc/issues/422) <https://github.com/numpy/numpydoc/pull/422>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Require sphinx>=4.2 (cleanup) `[#421](https://github.com/numpy/numpydoc/issues/421) <https://github.com/numpy/numpydoc/pull/421>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  docs: fix validation include line numbers `[#418](https://github.com/numpy/numpydoc/issues/418) <https://github.com/numpy/numpydoc/pull/418>`__ (`thatlittleboy <https://github.com/thatlittleboy>`__)
-  Update precommit linters `[#417](https://github.com/numpy/numpydoc/issues/417) <https://github.com/numpy/numpydoc/pull/417>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Update GH actions `[#416](https://github.com/numpy/numpydoc/issues/416) <https://github.com/numpy/numpydoc/pull/416>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  ENH: Add support for dict show_inherited_class_members `[#415](https://github.com/numpy/numpydoc/issues/415) <https://github.com/numpy/numpydoc/pull/415>`__ (`larsoner <https://github.com/larsoner>`__)
-  DOC: Add theme switcher and default to lightmode. `[#414](https://github.com/numpy/numpydoc/issues/414) <https://github.com/numpy/numpydoc/pull/414>`__ (`rossbar <https://github.com/rossbar>`__)
-  Require sphinx>=4.2 `[#411](https://github.com/numpy/numpydoc/issues/411) <https://github.com/numpy/numpydoc/pull/411>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)

* This Changelog was automatically generated by\ github_changelog_generator &lt;https://github.com/github-changelog-generator/github-changelog-generator&gt;__


1.4.0
</tr></table>

... (truncated)

Commits


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)