andreoliwa / nitpick

Enforce the same settings on multiple projects
https://nitpick.readthedocs.io/
MIT License
393 stars 24 forks source link

fix(deps): update dependency sphinx to v7 #599

Closed renovate[bot] closed 1 year ago

renovate[bot] commented 1 year ago

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sphinx (changelog) 5.3.0 -> 7.0.1 age adoption passing confidence

Release Notes

sphinx-doc/sphinx ### [`v7.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-701-released-May-12-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.0.0...v7.0.1) \===================================== ## Dependencies - [#​11411](https://togithub.com/sphinx-doc/sphinx/issues/11411): Support `Docutils 0.20`\_. Patch by Adam Turner. .. \_Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04 ## Bugs fixed - [#​11418](https://togithub.com/sphinx-doc/sphinx/issues/11418): Clean up remaining references to `sphinx.setup_command` following the removal of support for setuptools. Patch by Willem Mulder. ### [`v7.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-700-released-Apr-29-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.2.1...v7.0.0) \===================================== ## Incompatible changes - [#​11359](https://togithub.com/sphinx-doc/sphinx/issues/11359): Remove long-deprecated aliases for `MecabSplitter` and `DefaultSplitter` in `sphinx.search.ja`. - [#​11360](https://togithub.com/sphinx-doc/sphinx/issues/11360): Remove deprecated `make_old_id` functions in domain object description classes. - [#​11363](https://togithub.com/sphinx-doc/sphinx/issues/11363): Remove the Setuptools integration (`build_sphinx` hook in `setup.py`). - [#​11364](https://togithub.com/sphinx-doc/sphinx/issues/11364): Remove deprecated `sphinx.ext.napoleon.iterators` module. - [#​11365](https://togithub.com/sphinx-doc/sphinx/issues/11365): Remove support for the `jsdump` format in `sphinx.search`. - [#​11366](https://togithub.com/sphinx-doc/sphinx/issues/11366): Make `locale` a required argument to `sphinx.util.i18n.format_date()`. - [#​11370](https://togithub.com/sphinx-doc/sphinx/issues/11370): Remove deprecated `sphinx.util.stemmer` module. - [#​11371](https://togithub.com/sphinx-doc/sphinx/issues/11371): Remove deprecated `sphinx.pycode.ast.parse()` function. - [#​11372](https://togithub.com/sphinx-doc/sphinx/issues/11372): Remove deprecated `sphinx.io.read_doc()` function. - [#​11373](https://togithub.com/sphinx-doc/sphinx/issues/11373): Removed deprecated `sphinx.util.get_matching_files()` function. - [#​11378](https://togithub.com/sphinx-doc/sphinx/issues/11378): Remove deprecated `sphinx.util.docutils.is_html5_writer_available()` function. - [#​11379](https://togithub.com/sphinx-doc/sphinx/issues/11379): Make the `env` argument to `Builder` subclasses required. - [#​11380](https://togithub.com/sphinx-doc/sphinx/issues/11380): autosummary: Always emit grouped import exceptions. - [#​11381](https://togithub.com/sphinx-doc/sphinx/issues/11381): Remove deprecated `style` key for HTML templates. - [#​11382](https://togithub.com/sphinx-doc/sphinx/issues/11382): Remove deprecated `sphinx.writers.latex.LaTeXTranslator.docclasses` attribute. - [#​11383](https://togithub.com/sphinx-doc/sphinx/issues/11383): Remove deprecated `sphinx.builders.html.html5_ready` and `sphinx.builders.html.HTMLTranslator` attributes. - [#​11385](https://togithub.com/sphinx-doc/sphinx/issues/11385): Remove support for HTML 4 output. ### [`v6.2.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-621-released-Apr-25-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.2.0...v6.2.1) \===================================== ## Bugs fixed - [#​11355](https://togithub.com/sphinx-doc/sphinx/issues/11355): Revert the default type of :confval:`nitpick_ignore` and :confval:`nitpick_ignore_regex` to `list`. ### [`v6.2.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-620-released-Apr-23-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.3...v6.2.0) \===================================== ## Dependencies - Require Docutils 0.18.1 or greater. ## Incompatible changes - LaTeX: removal of some internal TeX `\dimen` registers (not previously publicly documented) as per 5.1.0 code comments in `sphinx.sty`: `\sphinxverbatimsep`, `\sphinxverbatimborder`, `\sphinxshadowsep`, `\sphinxshadowsize`, and `\sphinxshadowrule`. (refs: [#​11105](https://togithub.com/sphinx-doc/sphinx/issues/11105)) - Remove `.egg` support from pycode `ModuleAnalyser`; Python eggs are a now-obsolete binary distribution format - [#​11089](https://togithub.com/sphinx-doc/sphinx/issues/11089): Remove deprecated code in `sphinx.builders.linkcheck`. Patch by Daniel Eades - Remove internal-only `sphinx.locale.setlocale` ## Deprecated - [#​11247](https://togithub.com/sphinx-doc/sphinx/issues/11247): Deprecate the legacy `intersphinx_mapping` format - `sphinx.util.osutil.cd` is deprecated in favour of `contextlib.chdir`. ## Features added - [#​11277](https://togithub.com/sphinx-doc/sphinx/issues/11277): :rst:dir:`autoproperty` allows the return type to be specified as a type comment (e.g., `# type: () -> int`). Patch by Bénédikt Tran - [#​10811](https://togithub.com/sphinx-doc/sphinx/issues/10811): Autosummary: extend `__all__` to imported members for template rendering when option `autosummary_ignore_module_all` is set to `False`. Patch by Clement Pinard - [#​11147](https://togithub.com/sphinx-doc/sphinx/issues/11147): Add a `content_offset` parameter to `nested_parse_with_titles()`, allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard - Update to Unicode CLDR 42 - Add a `--jobs` synonym for `-j`. Patch by Hugo van Kemenade - LaTeX: a command `\sphinxbox` for styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See :ref:`sphinxbox`. (refs: [#​11224](https://togithub.com/sphinx-doc/sphinx/issues/11224)) - LaTeX: add `\sphinxstylenotetitle`, ..., `\sphinxstylewarningtitle`, ..., for an extra layer of mark-up freeing up `\sphinxstrong` for other uses. See :ref:`latex-macros`. (refs: [#​11267](https://togithub.com/sphinx-doc/sphinx/issues/11267)) - LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See :ref:`additionalcss`. (refs: [#​11234](https://togithub.com/sphinx-doc/sphinx/issues/11234)) - LaTeX: admonitions and :dudir:`topic` (and :dudir:`contents `) directives, and not only :rst:dir:`code-block`, support `box-decoration-break=slice`. - LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: [#​11243](https://togithub.com/sphinx-doc/sphinx/issues/11243)) - LaTeX: new options `noteTextColor`, `noteTeXextras` et al. See :ref:`additionalcss`. - LaTeX: support elliptical corners in rounded boxes. (refs: [#​11254](https://togithub.com/sphinx-doc/sphinx/issues/11254)) - [#​11150](https://togithub.com/sphinx-doc/sphinx/issues/11150): Include source location in highlighting warnings, when lexing fails. Patch by Jeremy Maitin-Shepard - [#​11281](https://togithub.com/sphinx-doc/sphinx/issues/11281): Support for :confval:`imgmath_latex` `= 'tectonic'` or `= 'xelatex'`. Patch by Dimitar Dimitrov - [#​11109](https://togithub.com/sphinx-doc/sphinx/issues/11109), [#​9643](https://togithub.com/sphinx-doc/sphinx/issues/9643): Add :confval:`python_display_short_literal_types` option for condensed rendering of `Literal` types. ## Bugs fixed - [#​11079](https://togithub.com/sphinx-doc/sphinx/issues/11079): LaTeX: figures with align attribute may disappear and strangely impact following lists - [#​11093](https://togithub.com/sphinx-doc/sphinx/issues/11093): LaTeX: fix "multiply-defined references" PDF build warnings when one or more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule` directive. Patch by Bénédikt Tran (picnixz) - [#​11110](https://togithub.com/sphinx-doc/sphinx/issues/11110): LaTeX: Figures go missing from latex pdf if their files have the same base name and they use a post transform. Patch by aaron-cooper - LaTeX: fix potential color leak from shadow to border of rounded boxes, if shadow color is set but border color is not - LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames respective to contents (when using rounded corners) - [#​11235](https://togithub.com/sphinx-doc/sphinx/issues/11235): LaTeX: added `\color` in topic (or admonition) contents may cause color leak to the shadow and border at a page break - [#​11264](https://togithub.com/sphinx-doc/sphinx/issues/11264): LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso` directive in French - [#​11268](https://togithub.com/sphinx-doc/sphinx/issues/11268): LaTeX: longtable with left alignment breaks out of current list indentation context in PDF. Thanks to picnixz. - [#​11274](https://togithub.com/sphinx-doc/sphinx/issues/11274): LaTeX: external links are not properly escaped for `\sphinxupquote` compatibility - [#​11147](https://togithub.com/sphinx-doc/sphinx/issues/11147): Fix source file/line number info in object description content and in other uses of `nested_parse_with_titles`. Patch by Jeremy Maitin-Shepard. - [#​11192](https://togithub.com/sphinx-doc/sphinx/issues/11192): Restore correct parallel search index building. Patch by Jeremy Maitin-Shepard - Use the new Transifex `tx` client ## Testing - Fail testing when any Python warnings are emitted - Migrate remaining `unittest.TestCase` style test functions to pytest style - Remove tests that rely on setuptools ### [`v6.1.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-613-released-Jan-10-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.2...v6.1.3) \===================================== ## Bugs fixed - [#​11116](https://togithub.com/sphinx-doc/sphinx/issues/11116): Reverted to previous Sphinx 5 node copying method - [#​11117](https://togithub.com/sphinx-doc/sphinx/issues/11117): Reverted changes to parallel image processing from Sphinx 6.1.0 - [#​11119](https://togithub.com/sphinx-doc/sphinx/issues/11119): Supress `ValueError` in the `linkcheck` builder ### [`v6.1.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-612-released-Jan-07-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.1...v6.1.2) \===================================== ## Bugs fixed - [#​11101](https://togithub.com/sphinx-doc/sphinx/issues/11101): LaTeX: `div.topic_padding` key of sphinxsetup documented at 5.1.0 was implemented with name `topic_padding` - [#​11099](https://togithub.com/sphinx-doc/sphinx/issues/11099): LaTeX: `shadowrule` key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0 - [#​11096](https://togithub.com/sphinx-doc/sphinx/issues/11096): LaTeX: `shadowsize` key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0 - [#​11095](https://togithub.com/sphinx-doc/sphinx/issues/11095): LaTeX: shadow of :dudir:`topic` and :dudir:`contents ` boxes not in page margin since Sphinx 5.1.0 - [#​11100](https://togithub.com/sphinx-doc/sphinx/issues/11100): Fix copying images when running under parallel mode. ### [`v6.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-611-released-Jan-05-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.0...v6.1.1) \===================================== ## Bugs fixed - [#​11091](https://togithub.com/sphinx-doc/sphinx/issues/11091): Fix `util.nodes.apply_source_workaround` for `literal_block` nodes with no source information in the node or the node's parents. ### [`v6.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-610-released-Jan-05-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.0.1...v6.1.0) \===================================== ## Dependencies - Adopted the `Ruff`\_ code linter. .. \_Ruff: https://github.com/charliermarsh/ruff ## Incompatible changes - [#​10979](https://togithub.com/sphinx-doc/sphinx/issues/10979): gettext: Removed support for pluralisation in `get_translation`. This was unused and complicated other changes to `sphinx.locale`. ## Deprecated - `sphinx.util` functions: - Renamed `sphinx.util.typing.stringify()` to `sphinx.util.typing.stringify_annotation()` - Moved `sphinx.util.xmlname_checker()` to `sphinx.builders.epub3._XML_NAME_PATTERN` Moved to `sphinx.util.display`: - `sphinx.util.status_iterator` - `sphinx.util.display_chunk` - `sphinx.util.SkipProgressMessage` - `sphinx.util.progress_message` Moved to `sphinx.util.http_date`: - `sphinx.util.epoch_to_rfc1123` - `sphinx.util.rfc1123_to_epoch` Moved to `sphinx.util.exceptions`: - `sphinx.util.save_traceback` - `sphinx.util.format_exception_cut_frames` ## Features added - Cache doctrees in the build environment during the writing phase. - Make all writing phase tasks support parallel execution. - [#​11072](https://togithub.com/sphinx-doc/sphinx/issues/11072): Use PEP 604 (`X | Y`) display conventions for `typing.Optional` and `typing.Optional` types within the Python domain and autodoc. - [#​10700](https://togithub.com/sphinx-doc/sphinx/issues/10700): autodoc: Document `typing.NewType()` types as classes rather than 'data'. - Cache doctrees between the reading and writing phases. ## Bugs fixed - [#​10962](https://togithub.com/sphinx-doc/sphinx/issues/10962): HTML: Fix the multi-word key name lookup table. - Fixed support for Python 3.12 alpha 3 (changes in the `enum` module). - [#​11069](https://togithub.com/sphinx-doc/sphinx/issues/11069): HTML Theme: Removed outdated "shortcut" link relation keyword. - [#​10952](https://togithub.com/sphinx-doc/sphinx/issues/10952): Properly terminate parallel processes on programme interuption. - [#​10988](https://togithub.com/sphinx-doc/sphinx/issues/10988): Speed up `TocTree.resolve()` through more efficient copying. - [#​6744](https://togithub.com/sphinx-doc/sphinx/issues/6744): LaTeX: support for seealso directive should be via an environment to allow styling. - [#​11074](https://togithub.com/sphinx-doc/sphinx/issues/11074): LaTeX: Can't change sphinxnote to use sphinxheavybox starting with 5.1.0 ### [`v6.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-601-released-Jan-05-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.0.0...v6.0.1) \===================================== ## Dependencies - Require Pygments 2.13 or later. ## Bugs fixed - [#​10944](https://togithub.com/sphinx-doc/sphinx/issues/10944): imgmath: Fix resolving image paths for files in nested folders. ### [`v6.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-600-released-Dec-29-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.3.0...v6.0.0) \===================================== ## Dependencies - [#​10468](https://togithub.com/sphinx-doc/sphinx/issues/10468): Drop Python 3.6 support - [#​10470](https://togithub.com/sphinx-doc/sphinx/issues/10470): Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner ## Incompatible changes - [#​7405](https://togithub.com/sphinx-doc/sphinx/issues/7405): Removed the jQuery and underscore.js JavaScript frameworks. These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the `jQuery`, `$`, or `$u` global objects, you need to update your JavaScript to modern standards, or use the mitigation below. The first option is to use the sphinxcontrib.jquery\_ extension, which has been developed by the Sphinx team and contributors. To use this, add `sphinxcontrib.jquery` to the `extensions` list in `conf.py`, or call `app.setup_extension("sphinxcontrib.jquery")` if you develop a Sphinx theme or extension. The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy `jquery.js` and `underscore.js` from `the Sphinx repository`\_ to your `static` directory, and add the following to your `layout.html`: .. code-block:: html+jinja {%- block scripts %} {{ super() }} {%- endblock %} .. \_sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/ Patch by Adam Turner. - [#​10471](https://togithub.com/sphinx-doc/sphinx/issues/10471), [#​10565](https://togithub.com/sphinx-doc/sphinx/issues/10565): Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:`dev-deprecated-apis` for details. Patch by Adam Turner. - [#​10901](https://togithub.com/sphinx-doc/sphinx/issues/10901): C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables `c_allow_pre_v3` and `c_warn_on_allowed_pre_v3`. Patch by Adam Turner. ## Features added - [#​10924](https://togithub.com/sphinx-doc/sphinx/issues/10924): LaTeX: adopt better looking defaults for tables and code-blocks. See :confval:`latex_table_style` and the `pre_border-radius` and `pre_background-TeXcolor` :ref:`additionalcss` for the former defaults and how to re-enact them if desired. ## Bugs fixed - [#​10984](https://togithub.com/sphinx-doc/sphinx/issues/10984): LaTeX: Document :confval:`latex_additional_files` behavior for files with `.tex` extension.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

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.



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

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 0.33.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: