Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx requirement from <3.4.0,>=3.2.0 to >=3.2.0,<3.5.0 #9

Closed

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Dec 28, 2020

Updates the requirements on sphinx to permit the latest version.

Changelog

Sourced from sphinx's changelog.

Release 3.4.1 (released Dec 25, 2020)

Bugs fixed

  • #8559: autodoc: AttributeError is raised when using forward-reference type annotations
  • #8568: autodoc: TypeError is raised on checking slots attribute
  • #8567: autodoc: Instance attributes are incorrectly added to Parent class
  • #8566: autodoc: The autodoc-process-docstring event is emitted to the alias classes unexpectedly
  • #8583: autodoc: Unnecessary object comparision via __eq__ method
  • #8565: linkcheck: Fix PriorityQueue crash when link tuples are not comparable

Release 3.4.0 (released Dec 20, 2020)

Incompatible changes

  • #8105: autodoc: the signature of class constructor will be shown for decorated classes, not a signature of decorator

Deprecated

  • The follow_wrapped argument of sphinx.util.inspect.signature()
  • The no_docstring argument of sphinx.ext.autodoc.Documenter.add_content()
  • sphinx.ext.autodoc.Documenter.get_object_members()
  • sphinx.ext.autodoc.DataDeclarationDocumenter
  • sphinx.ext.autodoc.GenericAliasDocumenter
  • sphinx.ext.autodoc.InstanceAttributeDocumenter
  • sphinx.ext.autodoc.SlotsAttributeDocumenter
  • sphinx.ext.autodoc.TypeVarDocumenter
  • sphinx.ext.autodoc.importer._getannotations()
  • sphinx.ext.autodoc.importer._getmro()
  • sphinx.pycode.ModuleAnalyzer.parse()
  • sphinx.util.osutil.movefile()
  • sphinx.util.requests.is_ssl_error()

Features added

  • #8119: autodoc: Allow to determine whether a member not included in __all__ attribute of the module should be documented or not via :event:autodoc-skip-member event
  • #8219: autodoc: Parameters for generic class are not shown when super class is

... (truncated)

Commits
  • f5406b9 Bump to 3.4.1 final
  • b94752a Merge pull request #8585 from tk0miya/8583_unnecessary_eq
  • 5c39d0c Fix #8583: autodoc: Unnecessary object comparision via __eq__ method
  • 0432604 Merge pull request #8581 from tk0miya/8566_autodoc_process_docstring_for_alia...
  • df8ab21 Fix #8566: autodoc-process-docstring is emitted to the alias classes
  • 46eaa5d Merge pull request #8579 from francoisfreitag/fix-queue
  • a1b8b1f Ensure linkcheck items are comparable
  • 955d655 Merge pull request #8571 from tk0miya/8567_wrong_ivars_in_parent_class
  • 70bb226 Fix #8567: autodoc: Instance attributes are incorrectly added to Parent class
  • 31cad2e Merge pull request #8570 from tk0miya/8569_getslots_TypeError
  • Additional commits viewable in compare view

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 [sphinx](https://github.com/sphinx-doc/sphinx) to permit the latest version.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/3.x/CHANGES)
- [Commits](sphinx-doc/sphinx@v3.2.0...v3.4.1)

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 28, 2020
@coveralls
Copy link

coveralls commented Dec 28, 2020

Pull Request Test Coverage Report for Build 448325915

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 445328123: 0.0%
Covered Lines: 125
Relevant Lines: 125

💛 - Coveralls

@domdfcoding
Copy link
Member

@dependabot ignore this minor version

@domdfcoding domdfcoding closed this Jan 5, 2021
@dependabot dependabot bot deleted the dependabot/pip/sphinx-gte-3.2.0-and-lt-3.5.0 branch January 5, 2021 10:44
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Jan 5, 2021

OK, I won't notify you about version 3.4.x again, unless you re-open this PR or update to a 3.4.x release yourself.

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

Successfully merging this pull request may close these issues.

None yet

2 participants