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

chore(deps): update dependency sphinx to v3.4.3 #1225

Merged
merged 1 commit into from Feb 4, 2021
Merged

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 2, 2020

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (source) ==3.2.1 -> ==3.4.3 age adoption passing confidence

Release Notes

sphinx-doc/sphinx

v3.4.3

Compare Source

=====================================

Bugs fixed

  • #​8655: autodoc: Failed to generate document if target module contains an
    object that raises an exception on hasattr()

v3.4.2

Compare Source

=====================================

Bugs fixed

  • #​8164: autodoc: Classes that inherit mocked class are not documented
  • #​8602: autodoc: The autodoc-process-docstring event is emitted to the
    non-datadescriptors unexpectedly
  • #​8616: autodoc: AttributeError is raised on non-class object is passed to
    autoclass directive

v3.4.1

Compare Source

=====================================

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

v3.4.0

Compare Source

=====================================

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.

Bugs fixed

  • #​7613: autodoc: autodoc does not respect signature of the class
  • #​4606: autodoc: the location of the warning is incorrect for inherited method
  • #​8105: autodoc: the signature of class constructor is incorrect if the class
    is decorated
  • #​8434: autodoc: :confval:autodoc_type_aliases does not effect to variables
    and attributes
  • #​8443: autodoc: autodata directive can't create document for PEP-526 based
    type annotated variables
  • #​8443: autodoc: autoattribute directive can't create document for PEP-526
    based uninitalized variables
  • #​8480: autodoc: autoattribute could not create document for slots
    attributes
  • #​8503: autodoc: autoattribute could not create document for a GenericAlias as
    class attributes correctly
  • #​8534: autodoc: autoattribute could not create document for a commented
    attribute in alias class
  • #​8452: autodoc: autodoc_type_aliases doesn't work when autodoc_typehints is
    set to "description"
  • #​8541: autodoc: autodoc_type_aliases doesn't work for the type annotation to
    instance attributes
  • #​8460: autodoc: autodata and autoattribute directives do not display type
    information of TypeVars
  • #​8493: autodoc: references to builtins not working in class aliases
  • #​8522: autodoc: __bool__ method could be called
  • #​8067: autodoc: A typehint for the instance variable having type_comment on
    super class is not displayed
  • #​8545: autodoc: a slots attribute is not documented even having docstring
  • #​741: autodoc: inherited-members doesn't work for instance attributes on super
    class
  • #​8477: autosummary: non utf-8 reST files are generated when template contains
    multibyte characters
  • #​8501: autosummary: summary extraction splits text after "el at." unexpectedly
  • #​8524: html: Wrong url_root has been generated on a document named "index"
  • #​8419: html search: Do not load language_data.js in non-search pages
  • #​8549: i18n: -D gettext_compact=0 is no longer working
  • #​8454: graphviz: The layout option for graph and digraph directives don't work
  • #​8131: linkcheck: Use GET when HEAD requests cause Too Many Redirects, to
    accommodate infinite redirect loops on HEAD
  • #​8437: Makefile: make clean with empty BUILDDIR is dangerous
  • #​8365: py domain: :type: and :rtype: gives false ambiguous class
    lookup warnings
  • #​8352: std domain: Failed to parse an option that starts with bracket
  • #​8519: LaTeX: Prevent page brake in the middle of a seealso
  • #​8520: C, fix copying of AliasNode.

v3.3.1

Compare Source

=====================================

Bugs fixed

  • #​8372: autodoc: autoclass directive became slower than Sphinx-3.2
  • #​7727: autosummary: raise PycodeError when documenting python package
    without init.py
  • #​8350: autosummary: autosummary_mock_imports causes slow down builds
  • #​8364: C, properly initialize attributes in empty symbols.
  • #​8399: i18n: Put system locale path after the paths specified by configuration

v3.3.0

Compare Source

=====================================

Deprecated

  • sphinx.builders.latex.LaTeXBuilder.usepackages
  • sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref
  • sphinx.ext.autodoc.SingledispatchFunctionDocumenter
  • sphinx.ext.autodoc.SingledispatchMethodDocumenter

Features added

  • #​8100: html: Show a better error message for failures on copying
    html_static_files
  • #​8141: C: added a maxdepth option to :rst:dir:c:alias to insert
    nested declarations.
  • #​8081: LaTeX: Allow to add LaTeX package via app.add_latex_package() until
    just before writing .tex file
  • #​7996: manpage: Add :confval:man_make_section_directory to make a section
    directory on build man page
  • #​8289: epub: Allow to suppress "duplicated ToC entry found" warnings from epub
    builder using :confval:suppress_warnings.
  • #​8298: sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option
  • #​8304: sphinx.testing: Register public markers in sphinx.testing.fixtures
  • #​8051: napoleon: use the obj role for all See Also items
  • #​8050: napoleon: Apply :confval:napoleon_preprocess_types to every field
  • C and C++, show line numbers for previous declarations when duplicates are
    detected.
  • #​8183: Remove substitution_reference nodes from doctree only on LaTeX builds

Bugs fixed

  • #​8085: i18n: Add support for having single text domain
  • #​6640: i18n: Failed to override system message translation
  • #​8143: autodoc: AttributeError is raised when False value is passed to
    autodoc_default_options
  • #​8103: autodoc: functools.cached_property is not considered as a property
  • #​8190: autodoc: parsing error is raised if some extension replaces docstring
    by string not ending with blank lines
  • #​8142: autodoc: Wrong constructor signature for the class derived from
    typing.Generic
  • #​8157: autodoc: TypeError is raised when annotation has invalid args
  • #​7964: autodoc: Tuple in default value is wrongly rendered
  • #​8200: autodoc: type aliases break type formatting of autoattribute
  • #​7786: autodoc: can't detect overloaded methods defined in other file
  • #​8294: autodoc: single-string slots is not handled correctly
  • #​7785: autodoc: autodoc_typehints='none' does not effect to overloaded functions
  • #​8192: napoleon: description is disappeared when it contains inline literals
  • #​8142: napoleon: Potential of regex denial of service in google style docs
  • #​8169: LaTeX: pxjahyper loaded even when latex_engine is not platex
  • #​8215: LaTeX: 'oneside' classoption causes build warning
  • #​8175: intersphinx: Potential of regex denial of service by broken inventory
  • #​8277: sphinx-build: missing and redundant spacing (and etc) for console
    output on building
  • #​7973: imgconverter: Check availability of imagemagick many times
  • #​8255: py domain: number in default argument value is changed from hexadecimal
    to decimal
  • #​8316: html: Prevent arrow keys changing page when button elements are focused
  • #​8343: html search: Fix unnecessary load of images when parsing the document
  • #​8254: html theme: Line numbers misalign with code lines
  • #​8093: The highlight warning has wrong location in some builders (LaTeX,
    singlehtml and so on)
  • #​8215: Eliminate Fancyhdr build warnings for oneside documents
  • #​8239: Failed to refer a token in productionlist if it is indented
  • #​8268: linkcheck: Report HTTP errors when linkcheck_anchors is True
  • #​8245: linkcheck: take source directory into account for local files
  • #​8321: linkcheck: tel: schema hyperlinks are detected as errors
  • #​8323: linkcheck: An exit status is incorrect when links having unsupported
    schema found
  • #​8188: C, add missing items to internal object types dictionary,
    e.g., preventing intersphinx from resolving them.
  • C, fix anon objects in intersphinx.
  • #​8270, C++, properly reject functions as duplicate declarations if a
    non-function declaration of the same name already exists.
  • C, fix references to function parameters.
    Link to the function instead of a non-existing anchor.
  • #​6914: figure numbers are unexpectedly assigned to uncaptioned items
  • #​8320: make "inline" line numbers un-selectable

Testing

  • #​8257: Support parallel build in sphinx.testing

Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by WhiteSource Renovate. View repository job log here.

@renovate renovate bot changed the title chore(deps): update dependency sphinx to v3.3.0 chore(deps): update dependency sphinx to v3.3.1 Nov 12, 2020
@renovate renovate bot changed the title chore(deps): update dependency sphinx to v3.3.1 chore(deps): update dependency sphinx to v3.4.0 Dec 20, 2020
@renovate renovate bot changed the title chore(deps): update dependency sphinx to v3.4.0 chore(deps): update dependency sphinx to v3.4.1 Dec 24, 2020
@renovate renovate bot changed the title chore(deps): update dependency sphinx to v3.4.1 chore(deps): update dependency sphinx to v3.4.2 Jan 4, 2021
@renovate renovate bot force-pushed the renovate/sphinx-3.x branch 2 times, most recently from ef65046 to 4634712 Compare January 7, 2021 16:42
@renovate renovate bot changed the title chore(deps): update dependency sphinx to v3.4.2 chore(deps): update dependency sphinx to v3.4.3 Jan 7, 2021
@nejch nejch merged commit a985c34 into master Feb 4, 2021
@renovate renovate bot deleted the renovate/sphinx-3.x branch February 4, 2021 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants