CODAIT / pardata

https://pardata.readthedocs.io/en/latest/
Apache License 2.0
17 stars 6 forks source link

Update dependency Sphinx to v4.5.0 #303

Open renovate[bot] opened 2 years ago

renovate[bot] commented 2 years ago

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
Sphinx (changelog) ==4.3.0 -> ==4.5.0 age adoption passing confidence
sphinx (changelog) ==4.3.0 -> ==4.5.0 age adoption passing confidence

Release Notes

sphinx-doc/sphinx ### [`v4.5.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-450-released-Mar-28-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.4.0...v4.5.0) \===================================== ## Incompatible changes - [#​10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Disable hardcoded links detector by default - [#​9993](https://togithub.com/sphinx-doc/sphinx/issues/9993), [#​10177](https://togithub.com/sphinx-doc/sphinx/issues/10177): std domain: Disallow to refer an inline target via :rst:role:`ref` role ## Deprecated - `sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()` ## Features added - [#​10260](https://togithub.com/sphinx-doc/sphinx/issues/10260): Enable `FORCE_COLOR` and `NO_COLOR` for terminal colouring - [#​10234](https://togithub.com/sphinx-doc/sphinx/issues/10234): autosummary: Add "autosummary" CSS class to summary tables - [#​10125](https://togithub.com/sphinx-doc/sphinx/issues/10125): extlinks: Improve suggestion message for a reference having title - [#​10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable hardcoded links detector feature - [#​9494](https://togithub.com/sphinx-doc/sphinx/issues/9494), [#​9456](https://togithub.com/sphinx-doc/sphinx/issues/9456): html search: Add a config variable :confval:`html_show_search_summary` to enable/disable the search summaries - [#​9337](https://togithub.com/sphinx-doc/sphinx/issues/9337): HTML theme, add option `enable_search_shortcuts` that enables :kbd:`/` as a Quick search shortcut and :kbd:`Esc` shortcut that removes search highlighting. - [#​10107](https://togithub.com/sphinx-doc/sphinx/issues/10107): i18n: Allow to suppress translation warnings by adding `#noqa` comment to the tail of each translation message - [#​10252](https://togithub.com/sphinx-doc/sphinx/issues/10252): C++, support attributes on classes, unions, and enums. - [#​10253](https://togithub.com/sphinx-doc/sphinx/issues/10253): :rst:role:`pep` role now generates URLs based on `peps.python.org `\_ ## Bugs fixed - [#​9876](https://togithub.com/sphinx-doc/sphinx/issues/9876): autodoc: Failed to document an imported class that is built from native binary module - [#​10133](https://togithub.com/sphinx-doc/sphinx/issues/10133): autodoc: Crashed when mocked module is used for type annotation - [#​10146](https://togithub.com/sphinx-doc/sphinx/issues/10146): autodoc: :confval:`autodoc_default_options` does not support `no-value` option - [#​9971](https://togithub.com/sphinx-doc/sphinx/issues/9971): autodoc: TypeError is raised when the target object is annotated by unhashable object - [#​10205](https://togithub.com/sphinx-doc/sphinx/issues/10205): extlinks: Failed to compile regexp on checking hardcoded links - [#​10277](https://togithub.com/sphinx-doc/sphinx/issues/10277): html search: Could not search short words (ex. "use") - [#​9529](https://togithub.com/sphinx-doc/sphinx/issues/9529): LaTeX: named auto numbered footnote (ex. `[#named]`) that is referred multiple times was rendered to a question mark - [#​9924](https://togithub.com/sphinx-doc/sphinx/issues/9924): LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical spacing in Latexpdf - [#​10158](https://togithub.com/sphinx-doc/sphinx/issues/10158): LaTeX: excessive whitespace since v4.4.0 for undocumented variables/structure members - [#​10175](https://togithub.com/sphinx-doc/sphinx/issues/10175): LaTeX: named footnote reference is linked to an incorrect footnote if the name is also used in the different document - [#​10269](https://togithub.com/sphinx-doc/sphinx/issues/10269): manpage: Failed to resolve the title of :rst:role:`ref` cross references - [#​10179](https://togithub.com/sphinx-doc/sphinx/issues/10179): i18n: suppress "rST localization" warning - [#​10118](https://togithub.com/sphinx-doc/sphinx/issues/10118): imgconverter: Unnecessary availablity check is called for remote URIs - [#​10181](https://togithub.com/sphinx-doc/sphinx/issues/10181): napoleon: attributes are displayed like class attributes for google style docstrings when :confval:`napoleon_use_ivar` is enabled - [#​10122](https://togithub.com/sphinx-doc/sphinx/issues/10122): sphinx-build: make.bat does not check the installation of sphinx-build command before showing help ### [`v4.4.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-440-released-Jan-17-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.3.2...v4.4.0) \===================================== ## Dependencies - [#​10007](https://togithub.com/sphinx-doc/sphinx/issues/10007): Use `importlib_metadata` for python-3.9 or older - [#​10007](https://togithub.com/sphinx-doc/sphinx/issues/10007): Drop `setuptools` ## Features added - [#​9075](https://togithub.com/sphinx-doc/sphinx/issues/9075): autodoc: Add a config variable :confval:`autodoc_typehints_format` to suppress the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`) - [#​9831](https://togithub.com/sphinx-doc/sphinx/issues/9831): Autosummary now documents only the members specified in a module's `__all__` attribute if :confval:`autosummary_ignore_module_all` is set to `False`. The default behaviour is unchanged. Autogen also now supports this behavior with the `--respect-module-all` switch. - [#​9555](https://togithub.com/sphinx-doc/sphinx/issues/9555): autosummary: Improve error messages on failure to load target object - [#​9800](https://togithub.com/sphinx-doc/sphinx/issues/9800): extlinks: Emit warning if a hardcoded link is replaceable by an extlink, suggesting a replacement. - [#​9961](https://togithub.com/sphinx-doc/sphinx/issues/9961): html: Support nested HTML elements in other HTML builders - [#​10013](https://togithub.com/sphinx-doc/sphinx/issues/10013): html: Allow to change the loading method of JS via `loading_method` parameter for :meth:`.Sphinx.add_js_file()` - [#​9551](https://togithub.com/sphinx-doc/sphinx/issues/9551): html search: "Hide Search Matches" link removes "highlight" parameter from URL - [#​9815](https://togithub.com/sphinx-doc/sphinx/issues/9815): html theme: Wrap sidebar components in div to allow customizing their layout via CSS - [#​9827](https://togithub.com/sphinx-doc/sphinx/issues/9827): i18n: Sort items in glossary by translated terms - [#​9899](https://togithub.com/sphinx-doc/sphinx/issues/9899): py domain: Allows to specify cross-reference specifier (`.` and `~`) as `:type:` option - [#​9894](https://togithub.com/sphinx-doc/sphinx/issues/9894): linkcheck: add option `linkcheck_exclude_documents` to disable link checking in matched documents. - [#​9793](https://togithub.com/sphinx-doc/sphinx/issues/9793): sphinx-build: Allow to use the parallel build feature in macOS on macOS and Python3.8+ - [#​10055](https://togithub.com/sphinx-doc/sphinx/issues/10055): sphinx-build: Create directories when `-w` option given - [#​9993](https://togithub.com/sphinx-doc/sphinx/issues/9993): std domain: Allow to refer an inline target (ex. \`\`\_`target name```) via :rst:role:`ref\` role - [#​9981](https://togithub.com/sphinx-doc/sphinx/issues/9981): std domain: Strip value part of the option directive from general index - [#​9391](https://togithub.com/sphinx-doc/sphinx/issues/9391): texinfo: improve variable in `samp` role - [#​9578](https://togithub.com/sphinx-doc/sphinx/issues/9578): texinfo: Add :confval:`texinfo_cross_references` to disable cross references for readability with standalone readers - [#​9822](https://togithub.com/sphinx-doc/sphinx/issues/9822) (and [#​9062](https://togithub.com/sphinx-doc/sphinx/issues/9062)), add new Intersphinx role :rst:role:`external` for explict lookup in the external projects, without resolving to the local project. ## Bugs fixed - [#​9866](https://togithub.com/sphinx-doc/sphinx/issues/9866): autodoc: doccomment for the imported class was ignored - [#​9883](https://togithub.com/sphinx-doc/sphinx/issues/9883): autodoc: doccomment for the alias to mocked object was ignored - [#​9908](https://togithub.com/sphinx-doc/sphinx/issues/9908): autodoc: debug message is shown on building document using NewTypes with Python 3.10 - [#​9968](https://togithub.com/sphinx-doc/sphinx/issues/9968): autodoc: instance variables are not shown if **init** method has position-only-arguments - [#​9194](https://togithub.com/sphinx-doc/sphinx/issues/9194): autodoc: types under the "typing" module are not hyperlinked - [#​10009](https://togithub.com/sphinx-doc/sphinx/issues/10009): autodoc: Crashes if target object raises an error on getting docstring - [#​10058](https://togithub.com/sphinx-doc/sphinx/issues/10058): autosummary: Imported members are not shown when `autodoc_class_signature = 'separated'` - [#​9947](https://togithub.com/sphinx-doc/sphinx/issues/9947): i18n: topic directive having a bullet list can't be translatable - [#​9878](https://togithub.com/sphinx-doc/sphinx/issues/9878): mathjax: MathJax configuration is placed after loading MathJax itself - [#​9932](https://togithub.com/sphinx-doc/sphinx/issues/9932): napoleon: empty "returns" section is generated even if no description - [#​9857](https://togithub.com/sphinx-doc/sphinx/issues/9857): Generated RFC links use outdated base url - [#​9909](https://togithub.com/sphinx-doc/sphinx/issues/9909): HTML, prevent line-wrapping in literal text. - [#​10061](https://togithub.com/sphinx-doc/sphinx/issues/10061): html theme: Configuration values added by themes are not be able to override from conf.py - [#​10073](https://togithub.com/sphinx-doc/sphinx/issues/10073): imgconverter: Unnecessary availablity check is called for "data" URIs - [#​9925](https://togithub.com/sphinx-doc/sphinx/issues/9925): LaTeX: prohibit also with `'xelatex'` line splitting at dashes of inline and parsed literals - [#​9944](https://togithub.com/sphinx-doc/sphinx/issues/9944): LaTeX: extra vertical whitespace for some nested declarations - [#​9940](https://togithub.com/sphinx-doc/sphinx/issues/9940): LaTeX: Multi-function declaration in Python domain has cramped vertical spacing in latexpdf output - [#​10015](https://togithub.com/sphinx-doc/sphinx/issues/10015): py domain: types under the "typing" module are not hyperlinked defined at info-field-list - [#​9390](https://togithub.com/sphinx-doc/sphinx/issues/9390): texinfo: Do not emit labels inside footnotes - [#​9413](https://togithub.com/sphinx-doc/sphinx/issues/9413): xml: Invalid XML was generated when cross referencing python objects - [#​9979](https://togithub.com/sphinx-doc/sphinx/issues/9979): Error level messages were displayed as warning messages - [#​10057](https://togithub.com/sphinx-doc/sphinx/issues/10057): Failed to scan documents if the project is placed onto the root directory - [#​9636](https://togithub.com/sphinx-doc/sphinx/issues/9636): code-block: `:dedent:` without argument did strip newlines ### [`v4.3.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-432-released-Dec-19-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.3.1...v4.3.2) \===================================== ## Bugs fixed - [#​9917](https://togithub.com/sphinx-doc/sphinx/issues/9917): C and C++, parse fundamental types no matter the order of simple type specifiers. ### [`v4.3.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-431-released-Nov-28-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.3.0...v4.3.1) \===================================== ## Features added - [#​9864](https://togithub.com/sphinx-doc/sphinx/issues/9864): mathjax: Support chnaging the loading method of MathJax to "defer" via :confval:`mathjax_options` ## Bugs fixed - [#​9838](https://togithub.com/sphinx-doc/sphinx/issues/9838): autodoc: AttributeError is raised on building document for functions decorated by functools.lru_cache - [#​9879](https://togithub.com/sphinx-doc/sphinx/issues/9879): autodoc: AttributeError is raised on building document for an object having invalid **doc** attribute - [#​9844](https://togithub.com/sphinx-doc/sphinx/issues/9844): autodoc: Failed to process a function wrapped with functools.partial if :confval:`autodoc_preserve_defaults` enabled - [#​9872](https://togithub.com/sphinx-doc/sphinx/issues/9872): html: Class namespace collision between autodoc signatures and docutils-0.17 - [#​9868](https://togithub.com/sphinx-doc/sphinx/issues/9868): imgmath: Crashed if the dvisvgm command failed to convert equation - [#​9864](https://togithub.com/sphinx-doc/sphinx/issues/9864): mathjax: Failed to render equations via MathJax v2. The loading method of MathJax is back to "async" method again

Configuration

📅 Schedule: Branch creation - "before 1am on Tuesday" (UTC), Automerge - 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 these updates again.



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

renovate[bot] commented 1 year ago

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.