malramsay64 / statdyn-analysis

Collection of tools for the statistical dynamics analysis of Molecular Dynamics trajectories.
MIT License
6 stars 0 forks source link

chore(deps-dev): Update sphinx-autodoc-typehints requirement from ~=1.7.0 to >=1.7,<1.9 #110

Closed dependabot-preview[bot] closed 5 years ago

dependabot-preview[bot] commented 5 years ago

Updates the requirements on sphinx-autodoc-typehints to permit the latest version.

Changelog *Sourced from [sphinx-autodoc-typehints's changelog](https://github.com/agronholm/sphinx-autodoc-typehints/blob/master/CHANGELOG.rst).* > 1.8.0 > ===== > > - Fixed regression which caused `TypeError` or `OSError` when trying to set annotations due to PR [#87](https://github-redirect.dependabot.com/agronholm/sphinx-autodoc-typehints/issues/87) > - Fixed unintentional mangling of annotation type names > - Added proper `:py:data` targets for `NoReturn`, `ClassVar` and `Tuple` > - Added support for inline type comments (like `(int, str) -> None`) (PR by Bernát Gábor) > - Use the native AST parser for type comment support on Python 3.8+ > > 1.7.0 > ===== > > - Dropped support for Python 3.4 > - Fixed unwrapped local functions causing errors (PR by Kimiyuki Onaka) > - Fixed `AttributeError` when documenting the `__init__()` method of a data class > - Added support for type hint comments (PR by Markus Unterwaditzer) > - Added flag for rendering classes with their fully qualified names (PR by Holly Becker) > > 1.6.0 > ===== > > - Fixed `TypeError` when formatting annotations from a class that inherits from a concrete generic type (report and tests by bpeake-illuscio) > - Added support for `typing_extensions.Protocol` (PR by Ian Good) > - Added support for `typing.NewType` (PR by George Leslie-Waksman) > > 1.5.2 > ===== > > - Emit a warning instead of crashing when an unresolvable forward reference is encountered in type annotations > > 1.5.1 > ===== > > - Fixed escape characters in parameter default values getting lost during signature processing > - Replaced use of the `config-inited` event (which inadvertently required Sphinx 1.8) with the `builder-inited` event > > 1.5.0 > ===== > > - The setting of the `typing.TYPECHECKING` flag is now configurable using the `set_type_checking_flag` option > > 1.4.0 > ===== > > - The extension now sets `typing.TYPECHECKING` to `True` during setup to include conditional imports which may be used in type annotations > - Fixed parameters with trailing underscores (PR by Daniel Knell) > - Fixed KeyError with private methods (PR by Benito Palacios Sánchez) > - Fixed deprecation warning about the use of formatargspec (PR by Y. Somda) > - The minimum Sphinx version is now v1.7.0 > > ... (truncated)
Commits - [`a1afbab`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/a1afbaba3067aee273ec0b14036e0f4ac44f79a9) Added the release version - [`17a84b5`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/17a84b583864608af96e1b46ae94b8c3e9013073) Added blank lines where necessary - [`35d41e7`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/35d41e79e4be82f217c2229524dbdc0e7935c68f) Flake8 fixes - [`6e34a8e`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/6e34a8e439f9c3afc2dec9d75cc88dfb0fe7a6e0) Added a project URL to the change log - [`98c497d`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/98c497d198354c07e85aee653b74e3ea14c3f25c) Fixed default values messing up type comment argument detection ([#102](https://github-redirect.dependabot.com/agronholm/sphinx-autodoc-typehints/issues/102)) - [`34828dd`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/34828dd4923bc38f2975e10a6dd4c66ec4efbb43) Added PEP 517 support ([#101](https://github-redirect.dependabot.com/agronholm/sphinx-autodoc-typehints/issues/101)) - [`4311b05`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/4311b053a9ad0f2c0a7071601501baade4c1d611) Documentation updates - [`c109b25`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/c109b251a2d729040c062e2cd5ea5a9203ffb8d9) Support type comments that are not inlined ([#100](https://github-redirect.dependabot.com/agronholm/sphinx-autodoc-typehints/issues/100)) - [`f14cc88`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/f14cc88560da6a33d7970b344e966841e6f76197) Ensure that the return type annotation is processed last - [`8c587db`](https://github.com/agronholm/sphinx-autodoc-typehints/commit/8c587db90e412acd5b76bab95b77aea2253ef1c9) Documentation updates - Additional commits viewable in [compare view](https://github.com/agronholm/sphinx-autodoc-typehints/compare/1.7.0...1.8.0)


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) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language - `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com): - Update frequency (including time of day and day of week) - Pull request limits (per update run and/or open at any time) - Out-of-range updates (receive only lockfile updates, if desired) - Security updates (receive only security updates, if desired) Finally, you can contact us by mentioning @dependabot.
dependabot-preview[bot] commented 5 years ago

Looks like sphinx-autodoc-typehints is up-to-date now, so this is no longer needed.