Skip to content

Bump sphinx from 3.3.1 to 3.4.0

Jonathan Weth requested to merge dependabot/pip/sphinx-3.4.0 into dev

Created by: dependabot-preview[bot]

Bumps sphinx from 3.3.1 to 3.4.0.

Changelog

Sourced from sphinx's changelog.

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 a generic class and show-inheritance option is given (in Python 3.7 or above)
  • autodoc: Add Documenter.config as a shortcut to access the config object
  • autodoc: Add Optional[t] to annotation of function and method if a default value equal to None is set.
  • #8209: autodoc: Add :no-value: option to :rst:dir:autoattribute and :rst:dir:autodata directive to suppress the default value of the variable
  • #8460: autodoc: Support custom types defined by typing.NewType
  • #8285: napoleon: Add :confval:napoleon_attr_annotations to merge type hints on source code automatically if any type is specified in docstring
  • #8236: napoleon: Support numpydoc's "Receives" section
  • #6914: Add a new event :event:warn-missing-reference to custom warning messages when failed to resolve a cross-reference
  • #6914: Emit a detailed warning when failed to resolve a :ref: reference
  • #6629: linkcheck: The builder now handles rate limits. See :confval:linkcheck_retry_on_rate_limit for details.
Commits
  • 79ff248 Bump to 3.4.0 final
  • 61fd867 Merged CHANGES for 3.3.2 into 3.4.0 (unreleased)
  • 723294f Merge pull request #8556 from tk0miya/8549_gettext_compact=0
  • 1977f3f Fix #8549: i18n: -D gettext_compact=0 is no longer working
  • 6e8ea85 Merge pull request #8552 from tk0miya/8236_napoleon_receives_section
  • 7f1284f Merge pull request #8555 from tk0miya/8512_test_comment
  • 2fa15e9 Merge pull request #8551 from tk0miya/8365_pydomain_xref_missing_context
  • 9a9d7f3 test: Add comment for UnicodeEncodeError handler (refs: #8512)
  • aae2f19 Merge pull request #8512 from jbms/fix-nonascii_srcdir
  • f50b999 Close #8236: napoleon: Support numpydoc's "Receives" section
  • Additional commits viewable in compare view

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)
  • @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:

  • 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)

Merge request reports