Skip to content

chore(deps): 🔨update dependency sphinx to v3.2.1

Mend Renovate requested to merge renovate/sphinx-3.x into master

This MR contains the following updates:

Package Update Change
sphinx (source) minor ==3.0.1 -> ==3.2.1

Release Notes

sphinx-doc/sphinx

v3.2.1

Compare Source

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

Features added

  • #​8095: napoleon: Add :confval:napoleon_preprocess_types to enable the type preprocessor for numpy style docstrings
  • #​8114: C and C++, parse function attributes after parameters and qualifiers.

Bugs fixed

  • #​8074: napoleon: Crashes during processing C-ext module
  • #​8088: napoleon: "Inline literal start-string without end-string" warning in Numpy style Parameters section
  • #​8084: autodoc: KeyError is raised on documenting an attribute of the broken class
  • #​8091: autodoc: AttributeError is raised on documenting an attribute on Python 3.5.2
  • #​8099: autodoc: NameError is raised when target code uses TYPE_CHECKING
  • C++, fix parsing of template template paramters, broken by the fix of #​7944

v3.2.0

Compare Source

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

Deprecated

  • sphinx.ext.autodoc.members_set_option()
  • sphinx.ext.autodoc.merge_special_members_option()
  • sphinx.writers.texinfo.TexinfoWriter.desc
  • C, parsing of pre-v3 style type directives and roles, along with the options :confval:c_allow_pre_v3 and :confval:c_warn_on_allowed_pre_v3.

Features added

  • #​2076: autodoc: Allow overriding of exclude-members in skip-member function
  • #​8034: autodoc: :private-member: can take an explicit list of member names to be documented
  • #​2024: autosummary: Add :confval:autosummary_filename_map to avoid conflict of filenames between two object with different case
  • #​8011: autosummary: Support instance attributes as a target of autosummary directive
  • #​7849: html: Add :confval:html_codeblock_linenos_style to change the style of line numbers for code-blocks
  • #​7853: C and C++, support parameterized GNU style attributes.
  • #​7888: napoleon: Add aliases Warn and Raise.
  • #​7690: napoleon: parse type strings and make them hyperlinks as possible. The conversion rule can be updated via :confval:napoleon_type_aliases
  • #​8049: napoleon: Create a hyperlink for each the type of parameter when :confval:napoleon_use_params is False
  • C, added :rst:dir:c:alias directive for inserting copies of existing declarations.
  • #​7745: html: inventory is broken if the docname contains a space
  • #​7991: html search: Allow searching for numbers
  • #​7902: html theme: Add a new option :confval:globaltoc_maxdepth to control the behavior of globaltoc in sidebar
  • #​7840: i18n: Optimize the dependencies check on bootstrap
  • #​7768: i18n: :confval:figure_language_filename supports docpath token
  • #​5208: linkcheck: Support checks for local links
  • #​5090: setuptools: Link verbosity to distutils' -v and -q option
  • #​6698: doctest: Add :trim-doctest-flags: and :no-trim-doctest-flags: options to doctest, testcode and testoutput directives
  • #​7052: add :noindexentry: to the Python, C, C++, and Javascript domains. Update the documentation to better reflect the relationship between this option and the :noindex: option.
  • #​7899: C, add possibility of parsing of some pre-v3 style type directives and roles and try to convert them to equivalent v3 directives/roles. Set the new option :confval:c_allow_pre_v3 to True to enable this. The warnings printed from this functionality can be suppressed by setting :confval:`c_warn_on_allowed_pre_v3toTrue``. The functionality is immediately deprecated.
  • #​7999: C, add support for named variadic macro arguments.
  • #​8071: Allow to suppress "self referenced toctrees" warning

Bugs fixed

  • #​7886: autodoc: TypeError is raised on mocking generic-typed classes
  • #​7935: autodoc: function signature is not shown when the function has a parameter having inspect._empty as its default value
  • #​7901: autodoc: type annotations for overloaded functions are not resolved
  • #​904: autodoc: An instance attribute cause a crash of autofunction directive
  • #​1362: autodoc: private-members option does not work for class attributes
  • #​7983: autodoc: Generator type annotation is wrongly rendered in py36
  • #​8030: autodoc: An uninitialized annotated instance variable is not documented when :inherited-members: option given
  • #​8032: autodoc: A type hint for the instance variable defined at parent class is not shown in the document of the derived class
  • #​8041: autodoc: An annotated instance variable on super class is not documented when derived class has other annotated instance variables
  • #​7839: autosummary: cannot handle umlauts in function names
  • #​7865: autosummary: Failed to extract summary line when abbreviations found
  • #​7866: autosummary: Failed to extract correct summary line when docstring contains a hyperlink target
  • #​7469: autosummary: "Module attributes" header is not translatable
  • #​7940: apidoc: An extra newline is generated at the end of the rst file if a module has submodules
  • #​4258: napoleon: decorated special methods are not shown
  • #​7799: napoleon: parameters are not escaped for combined params in numpydoc
  • #​7780: napoleon: multiple paramaters declaration in numpydoc was wrongly recognized when napoleon_use_params=True
  • #​7715: LaTeX: numfig_secnum_depth > 1 leads to wrong figure links
  • #​7846: html theme: XML-invalid files were generated
  • #​7894: gettext: Wrong source info is shown when using rst_epilog
  • #​7691: linkcheck: HEAD requests are not used for checking
  • #​4888: i18n: Failed to add an explicit title to :ref: role on translation
  • #​7928: py domain: failed to resolve a type annotation for the attribute
  • #​8008: py domain: failed to parse a type annotation containing ellipsis
  • #​7994: std domain: option directive does not generate old node_id compatible with 2.x or older
  • #​7968: i18n: The content of math directive is interpreted as reST on translation
  • #​7768: i18n: The root element for :confval:figure_language_filename is not a path that user specifies in the document
  • #​7993: texinfo: TypeError is raised for nested object descriptions
  • #​7993: texinfo: a warning not supporting desc_signature_line node is shown
  • #​7869: :rst:role:abbr role without an explanation will show the explanation from the previous abbr role
  • #​8048: graphviz: graphviz.css was copied on building non-HTML document
  • C and C++, removed noindex directive option as it did nothing.
  • #​7619: Duplicated node IDs are generated if node has multiple IDs
  • #​2050: Symbols sections are appeared twice in the index page
  • #​8017: Fix circular import in sphinx.addnodes
  • #​7986: CSS: make "highlight" selector more robust
  • #​7944: C++, parse non-type template parameters starting with a dependent qualified name.
  • C, don't deepcopy the entire symbol table and make a mess every time an enumerator is handled.

v3.1.2

Compare Source

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

Incompatible changes

  • #​7650: autodoc: the signature of base function will be shown for decorated functions, not a signature of decorator

Bugs fixed

  • #​7844: autodoc: Failed to detect module when relative module name given
  • #​7856: autodoc: AttributeError is raised when non-class object is given to the autoclass directive
  • #​7850: autodoc: KeyError is raised for invalid mark up when autodoc_typehints is 'description'
  • #​7812: autodoc: crashed if the target name matches to both an attribute and module that are same name
  • #​7650: autodoc: function signature becomes (*args, **kwargs) if the function is decorated by generic decorator
  • #​7812: autosummary: generates broken stub files if the target code contains an attribute and module that are same name
  • #​7806: viewcode: Failed to resolve viewcode references on 3rd party builders
  • #​7838: html theme: List items have extra vertical space
  • #​7878: html theme: Undesired interaction between "overflow" and "float"

v3.1.1

Compare Source

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

Incompatible changes

  • #​7808: napoleon: a type for attribute are represented as typed field

Features added

  • #​7807: autodoc: Show detailed warning when type_comment is mismatched with its signature

Bugs fixed

  • #​7808: autodoc: Warnings raised on variable and attribute type annotations
  • #​7802: autodoc: EOFError is raised on parallel build
  • #​7821: autodoc: TypeError is raised for overloaded C-ext function
  • #​7805: autodoc: an object which descriptors returns is unexpectedly documented
  • #​7807: autodoc: wrong signature is shown for the function using contextmanager
  • #​7812: autosummary: generates broken stub files if the target code contains an attribute and module that are same name
  • #​7808: napoleon: Warnings raised on variable and attribute type annotations
  • #​7811: sphinx.util.inspect causes circular import problem

v3.1.0

Compare Source

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

Dependencies

Incompatible changes

  • #​7477: imgconverter: Invoke "magick convert" command by default on Windows

Deprecated

  • The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has been changed to Sphinx object
  • sphinx.ext.autosummary.generate.AutosummaryRenderer takes an object type as an argument
  • The ignore argument of sphinx.ext.autodoc.Documenter.get_doc()
  • The template_dir argument of sphinx.ext.autosummary.generate. AutosummaryRenderer
  • The module argument of sphinx.ext.autosummary.generate. find_autosummary_in_docstring()
  • The builder argument of sphinx.ext.autosummary.generate. generate_autosummary_docs()
  • The template_dir argument of sphinx.ext.autosummary.generate. generate_autosummary_docs()
  • The ignore argument of sphinx.util.docstring.prepare_docstring()
  • sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()
  • sphinx.util.rpartition()

Features added

  • LaTeX: Make the toplevel_sectioning setting optional in LaTeX theme
  • LaTeX: Allow to override papersize and pointsize from LaTeX themes
  • LaTeX: Add :confval:latex_theme_options to override theme options
  • #​7410: Allow to suppress "circular toctree references detected" warnings using :confval:suppress_warnings
  • C, added scope control directives, :rst:dir:c:namespace, :rst:dir:c:namespace-push, and :rst:dir:c:namespace-pop.
  • #​2044: autodoc: Suppress default value for instance attributes
  • #​7473: autodoc: consider a member public if docstring contains :meta public: in info-field-list
  • #​7487: autodoc: Allow to generate docs for singledispatch functions by py:autofunction
  • #​7143: autodoc: Support final classes and methods
  • #​7384: autodoc: Support signatures defined by __new__(), metaclasses and builtin base classes
  • #​2106: autodoc: Support multiple signatures on docstring
  • #​4422: autodoc: Support GenericAlias in Python 3.7 or above
  • #​3610: autodoc: Support overloaded functions
  • #​7722: autodoc: Support TypeVar
  • #​7466: autosummary: headings in generated documents are not translated
  • #​7490: autosummary: Add :caption: option to autosummary directive to set a caption to the toctree
  • #​7469: autosummary: Support module attributes
  • #​248, #​6040: autosummary: Add :recursive: option to autosummary directive to generate stub files recursively
  • #​4030: autosummary: Add :confval:autosummary_context to add template variables for custom templates
  • #​7530: html: Support nested elements
  • #​7481: html theme: Add right margin to footnote/citation labels
  • #​7482, #​7717: html theme: CSS spacing for code blocks with captions and line numbers
  • #​7443: html theme: Add new options :confval:globaltoc_collapse and :confval:globaltoc_includehidden to control the behavior of globaltoc in sidebar
  • #​7484: html theme: Avoid clashes between sidebar and other blocks
  • #​7476: html theme: Relbar breadcrumb should contain current page
  • #​7506: html theme: A canonical URL is not escaped
  • #​7533: html theme: Avoid whitespace at the beginning of genindex.html
  • #​7541: html theme: Add a "clearer" at the end of the "body"
  • #​7542: html theme: Make admonition/topic/sidebar scrollable
  • #​7543: html theme: Add top and bottom margins to tables
  • #​7695: html theme: Add viewport meta tag for basic theme
  • #​7721: html theme: classic: default codetextcolor/codebgcolor doesn't override Pygments
  • C and C++: allow semicolon in the end of declarations.
  • C++, parse parameterized noexcept specifiers.
  • #​7294: C++, parse expressions with user-defined literals.
  • C++, parse trailing return types.
  • #​7143: py domain: Add :final: option to :rst:dir:py:class:, :rst:dir:py:exception: and :rst:dir:py:method: directives
  • #​7596: py domain: Change a type annotation for variables to a hyperlink
  • #​7770: std domain: :rst:dir:option directive support arguments in the form of foo[=bar]
  • #​7582: napoleon: a type for attribute are represented like type annotation
  • #​7734: napoleon: overescaped trailing underscore on attribute
  • #​7247: linkcheck: Add :confval:linkcheck_request_headers to send custom HTTP headers for specific host
  • #​7792: setuptools: Support --verbosity option
  • #​7683: Add allowed_exceptions parameter to Sphinx.emit() to allow handlers to raise specified exceptions
  • #​7295: C++, parse (trailing) requires clauses.

Bugs fixed

  • #​6703: autodoc: incremental build does not work for imported objects
  • #​7564: autodoc: annotations not to be shown for descriptors
  • #​6588: autodoc: Decorated inherited method has no documentation
  • #​7469: autodoc: The change of autodoc-process-docstring for variables is cached unexpectedly
  • #​7559: autodoc: misdetects a sync function is async
  • #​6857: autodoc: failed to detect a classmethod on Enum class
  • #​7562: autodoc: a typehint contains spaces is wrongly rendered under autodoc_typehints='description' mode
  • #​7551: autodoc: failed to import nested class
  • #​7362: autodoc: does not render correct signatures for built-in functions
  • #​7654: autodoc: Optional[Union[foo, bar]] is presented as Union[foo, bar, None]
  • #​7629: autodoc: autofunction emits an unfriendly warning if an invalid object specified
  • #​7650: autodoc: undecorated signature is shown for decorated functions
  • #​7676: autodoc: typo in the default value of autodoc_member_order
  • #​7676: autodoc: wrong value for :member-order: option is ignored silently
  • #​7676: autodoc: member-order="bysource" does not work for C module
  • #​3673: autodoc: member-order="bysource" does not work for a module having all
  • #​7668: autodoc: wrong retann va

Renovate configuration

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

🚦 Automerge: Enabled.

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

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

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

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

Edited by Mend Renovate

Merge request reports