Skip to content
This repository has been archived by the owner on Apr 10, 2022. It is now read-only.

build(deps): Update numpydoc requirement from ~=1.1 to ~=1.2 #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 24, 2022

Updates the requirements on numpydoc to permit the latest version.

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
Changelog

Sourced from numpydoc's changelog.

Release notes

.. roughly following https://sphinx-gallery.github.io/dev/maintainers.html, .. 1.0.0 notes were generated by: .. 1. tagging PRs as enhancement/bug/removed .. 2. $ github_changelog_generator -u numpy -p numpydoc --since-tag=v0.9.2 .. 3. $ pandoc CHANGELOG.md --wrap=none -o release_notes.rst .. 4. adding a manual addition (CSS note), tweaking heading levels, adding TOC

.. contents:: Page contents :local: :depth: 2

.. note::

For release notes (sparsely) kept prior to 1.0.0, look at the releases page on GitHub <https://github.com/numpy/numpydoc/releases>__.

1.2.0

Release date: 24 January 2022

Requires Python 3.7+ and Sphinx 1.8+.

Implemented enhancements


-  Document release process `[#357](https://github.com/numpy/numpydoc/issues/357) <https://github.com/numpy/numpydoc/pull/357>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  Use setuptools `[#349](https://github.com/numpy/numpydoc/issues/349) <https://github.com/numpy/numpydoc/pull/349>`__ (`jarrodmillman <https://github.com/jarrodmillman>`__)
-  DOC: Switch docs to pydata-sphinx-theme `[#313](https://github.com/numpy/numpydoc/issues/313) <https://github.com/numpy/numpydoc/pull/313>`__ (`rossbar <https://github.com/rossbar>`__)
-  Improve error messages for see also parsing `[#306](https://github.com/numpy/numpydoc/issues/306) <https://github.com/numpy/numpydoc/pull/306>`__ (`rossbar <https://github.com/rossbar>`__)
-  ENH: Enable validation during sphinx-build process `[#302](https://github.com/numpy/numpydoc/issues/302) <https://github.com/numpy/numpydoc/pull/302>`__ (`rossbar <https://github.com/rossbar>`__)
-  Add a note to the docstring standard about long ‘See Also’ entries. `[#300](https://github.com/numpy/numpydoc/issues/300) <https://github.com/numpy/numpydoc/pull/300>`__ (`WarrenWeckesser <https://github.com/WarrenWeckesser>`__)
-  MAINT: minor refactoring in docscrape `[#297](https://github.com/numpy/numpydoc/issues/297) <https://github.com/numpy/numpydoc/pull/297>`__ (`rossbar <https://github.com/rossbar>`__)
-  ENH: Add configuration option for parameter cross-referencing `[#295](https://github.com/numpy/numpydoc/issues/295) <https://github.com/numpy/numpydoc/pull/295>`__ (`rossbar <https://github.com/rossbar>`__)
-  ENH: Better warning for sections. `[#278](https://github.com/numpy/numpydoc/issues/278) <https://github.com/numpy/numpydoc/pull/278>`__ (`Carreau <https://github.com/Carreau>`__)

Fixed bugs


-  How to specify that parameter can equal the string ‘integer’? `[#341](https://github.com/numpy/numpydoc/issues/341) &lt;https://github.com/numpy/numpydoc/issues/341&gt;`__
-  Fix validation bug when parameter type is set of options. `[#347](https://github.com/numpy/numpydoc/issues/347) &lt;https://github.com/numpy/numpydoc/pull/347&gt;`__ (`rossbar &lt;https://github.com/rossbar&gt;`__)
-  Escape newline in docstring. `[#345](https://github.com/numpy/numpydoc/issues/345) &lt;https://github.com/numpy/numpydoc/pull/345&gt;`__ (`Carreau &lt;https://github.com/Carreau&gt;`__)
-  Correctly validate parameters under the “Other Parameters” section `[#337](https://github.com/numpy/numpydoc/issues/337) &lt;https://github.com/numpy/numpydoc/pull/337&gt;`__ (`dcbr &lt;https://github.com/dcbr&gt;`__)
-  BUG: fix an incomplete check in ``Reader.\_error\_location`` `[#308](https://github.com/numpy/numpydoc/issues/308) &lt;https://github.com/numpy/numpydoc/pull/308&gt;`__ (`rgommers &lt;https://github.com/rgommers&gt;`__)
-  MAINT: pytest ignore doc directory. `[#296](https://github.com/numpy/numpydoc/issues/296) &lt;https://github.com/numpy/numpydoc/pull/296&gt;`__ (`rossbar &lt;https://github.com/rossbar&gt;`__)
-  DOC: fix inaccuracy in validate docstring. `[#294](https://github.com/numpy/numpydoc/issues/294) &lt;https://github.com/numpy/numpydoc/pull/294&gt;`__ (`rossbar &lt;https://github.com/rossbar&gt;`__)
-  Fix param parsing. `[#286](https://github.com/numpy/numpydoc/issues/286) &lt;https://github.com/numpy/numpydoc/pull/286&gt;`__ (`Carreau &lt;https://github.com/Carreau&gt;`__)
&lt;/tr&gt;&lt;/table&gt; 
</code></pre>
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>

<ul>
<li><a href="https://github.com/numpy/numpydoc/commit/9ff24c084d53756b88d0826a6d9e5c2840a3d1be&quot;&gt;&lt;code&gt;9ff24c0&lt;/code&gt;&lt;/a> Designate 1.2 release</li>
<li><a href="https://github.com/numpy/numpydoc/commit/a87f876ee5ac17fcfb350c9ccec1660d489479b2&quot;&gt;&lt;code&gt;a87f876&lt;/code&gt;&lt;/a> Add 1.2 release notes (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/359&quot;&gt;#359&lt;/a&gt;)&lt;/li>
<li><a href="https://github.com/numpy/numpydoc/commit/631828f4a63e97a075e375211a824e2147fe81cd&quot;&gt;&lt;code&gt;631828f&lt;/code&gt;&lt;/a> Document release process (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/357&quot;&gt;#357&lt;/a&gt;)&lt;/li>
<li><a href="https://github.com/numpy/numpydoc/commit/70ef956f7ad656a37304e9f05dfa056091de7178&quot;&gt;&lt;code&gt;70ef956&lt;/code&gt;&lt;/a> Fix CI (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/358&quot;&gt;#358&lt;/a&gt;)&lt;/li>
<li><a href="https://github.com/numpy/numpydoc/commit/76b5ea206492e3e3c402f3468eda897ffc928b2c&quot;&gt;&lt;code&gt;76b5ea2&lt;/code&gt;&lt;/a> Bump version</li>
<li>See full diff in <a href="https://github.com/numpy/numpydoc/compare/numpydoc-1.2rc1...numpydoc-1.2&quot;&gt;compare view</a></li>
</ul>
</details>

<br />

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)

Updates the requirements on [numpydoc](https://github.com/numpy/numpydoc) to permit the latest version.
- [Release notes](https://github.com/numpy/numpydoc/releases)
- [Changelog](https://github.com/numpy/numpydoc/blob/main/doc/release_notes.rst)
- [Commits](numpy/numpydoc@numpydoc-1.2rc1...numpydoc-1.2)

---
updated-dependencies:
- dependency-name: numpydoc
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jan 24, 2022
@ghost
Copy link

ghost commented Jan 24, 2022

Sider has detected 7 errors on analyzing the commit efbd60d.

If the errors persist even after retrying, the following actions may resolve them:

If you still have problems, feel free to ask us via chat. 💬


You can turn off such notifications if unnecessary.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants