search

FirefoxMetzger / scikit-bot

Robotics in Python
Apache License 2.0
13 stars 2 forks source link

MAINT: Bump numpydoc from 1.1.0 to 1.2 #147

Closed dependabot[bot] closed 2 years ago

dependabot[bot] commented 2 years ago

Bumps numpydoc from 1.1.0 to 1.2.

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"><code>9ff24c0</code></a> Designate 1.2 release</li>
<li><a href="https://github.com/numpy/numpydoc/commit/a87f876ee5ac17fcfb350c9ccec1660d489479b2"><code>a87f876</code></a> Add 1.2 release notes (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/359">#359</a>)</li>
<li><a href="https://github.com/numpy/numpydoc/commit/631828f4a63e97a075e375211a824e2147fe81cd"><code>631828f</code></a> Document release process (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/357">#357</a>)</li>
<li><a href="https://github.com/numpy/numpydoc/commit/70ef956f7ad656a37304e9f05dfa056091de7178"><code>70ef956</code></a> Fix CI (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/358">#358</a>)</li>
<li><a href="https://github.com/numpy/numpydoc/commit/76b5ea206492e3e3c402f3468eda897ffc928b2c"><code>76b5ea2</code></a> Bump version</li>
<li><a href="https://github.com/numpy/numpydoc/commit/fd77800c4fe60367bdd74c1e5efebb5ccf82b45f"><code>fd77800</code></a> Designate 1.2rc1 release</li>
<li><a href="https://github.com/numpy/numpydoc/commit/e9384ce346359cbec556454ae69c1af44d6a9017"><code>e9384ce</code></a> Use fstrings (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/353">#353</a>)</li>
<li><a href="https://github.com/numpy/numpydoc/commit/bbdf1763210e549e2371a962eb58b002ce5f6760"><code>bbdf176</code></a> Require sphinx &gt;= 1.8 (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/352">#352</a>)</li>
<li><a href="https://github.com/numpy/numpydoc/commit/f25273e6447288441d3e6941eca5dba3d3f1c497"><code>f25273e</code></a> Add badges (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/354">#354</a>)</li>
<li><a href="https://github.com/numpy/numpydoc/commit/02d6842d6e8351769f854012d448c1877fe3c5bc"><code>02d6842</code></a> Fix typos found by codespell (<a href="https://github-redirect.dependabot.com/numpy/numpydoc/issues/343">#343</a>)</li>
<li>Additional commits viewable in <a href="https://github.com/numpy/numpydoc/compare/v1.1.0...numpydoc-1.2">compare view</a></li>
</ul>
</details>

<br />



[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=numpydoc&package-manager=pip&previous-version=1.1.0&new-version=1.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

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-automerge-start)
[//]: # (dependabot-automerge-end)

---



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)