codecov-commenter
commented
1 year ago Codecov Report
Merging #122 (6cee992) into main (a0ad4f5) will not change coverage. The diff coverage is
n/a.
:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.
@@ Coverage Diff @@
## main #122 +/- ##
=======================================
Coverage 95.61% 95.61%
=======================================
Files 5 5
Lines 251 251
=======================================
Hits 240 240
Misses 11 11
This PR contains the following updates:
<5.2-><7.2Release Notes
sphinx-doc/sphinx
### [`v7.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-711-released-Jul-27-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.1.0...v7.1.1) \===================================== ## Bugs fixed - [#11514](https://togithub.com/sphinx-doc/sphinx/issues/11514): Fix `SOURCE_DATE_EPOCH` in multi-line copyright footer. Patch by Bénédikt Tran. ### [`v7.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-710-released-Jul-24-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.0.1...v7.1.0) \===================================== ## Incompatible changes - Releases are no longer signed, given the `change in PyPI policy`\_. .. \_change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ ## Deprecated - [#11412](https://togithub.com/sphinx-doc/sphinx/issues/11412): Emit warnings on using a deprecated Python-specific index entry type (namely, `module`, `keyword`, `operator`, `object`, `exception`, `statement`, and `builtin`) in the :rst:dir:`index` directive, and set the removal version to Sphinx 9. Patch by Adam Turner. ## Features added - [#11415](https://togithub.com/sphinx-doc/sphinx/issues/11415): Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm. - :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version requirement to be specified as `(major, minor)`. - [#11011](https://togithub.com/sphinx-doc/sphinx/issues/11011): Allow configuring a line-length limit for object signatures, via :confval:`maximum_signature_line_length` and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example :rst:dir:`py:function:single-line-parameter-list`. Patch by Thomas Louf, Adam Turner, and Jean-François B. - [#10983](https://togithub.com/sphinx-doc/sphinx/issues/10983): Support for multiline copyright statements in the footer block. Patch by Stefanie Molin - `sphinx.util.display.status_iterator` now clears the current line with ANSI control codes, rather than overprinting with space characters. - [#11431](https://togithub.com/sphinx-doc/sphinx/issues/11431): linkcheck: Treat SSL failures as broken links. Patch by Bénédikt Tran - [#11157](https://togithub.com/sphinx-doc/sphinx/issues/11157): Keep the `translated` attribute on translated nodes. - [#11451](https://togithub.com/sphinx-doc/sphinx/issues/11451): Improve the traceback displayed when using :option:`sphinx-build -T` in parallel builds. Patch by Bénédikt Tran - [#11324](https://togithub.com/sphinx-doc/sphinx/issues/11324): linkcheck: Use session-basd HTTP requests. - [#11438](https://togithub.com/sphinx-doc/sphinx/issues/11438): Add support for the :rst:dir:`py:class` and :rst:dir:`py:function` directives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support ([#11011](https://togithub.com/sphinx-doc/sphinx/issues/11011)) is enabled for type parameters list and can be locally controlled on object description directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`. Patch by Bénédikt Tran. - [#11484](https://togithub.com/sphinx-doc/sphinx/issues/11484): linkcheck: Allow HTML anchors to be ignored on a per-URL basis via :confval:`linkcheck_anchors_ignore_for_url` while still checking the validity of the page itself. Patch by Bénédikt Tran - [#1246](https://togithub.com/sphinx-doc/sphinx/issues/1246): Add translation progress statistics and inspection support, via a new substitution (`|translation progress|`) and a new configuration variable (:confval:`translation_progress_classes`). These enable determining the percentage of translated elements within a document, and the remaining translated and untranslated elements. ## Bugs fixed - Restored the `footnote-reference` class that has been removed in the latest (unreleased) version of Docutils. - [#11486](https://togithub.com/sphinx-doc/sphinx/issues/11486): Use :rfc:`8081` font file MIME types in the EPUB builder. Using the correct MIME type will prevent warnings from `epubcheck` and will generate a valid EPUB. - [#11435](https://togithub.com/sphinx-doc/sphinx/issues/11435): Use microsecond-resolution timestamps for outdated file detection in `BuildEnvironment.get_outdated_files`. - [#11437](https://togithub.com/sphinx-doc/sphinx/issues/11437): Top-level headings starting with a reStructuredText role now render properly when :confval:`rst_prolog` is set. Previously, a file starting with the below would have improperly rendered due to where the prologue text was inserted into the document. .. code:: rst # :mod:`lobster` -- The lobster module ... Patch by Bénédikt Tran. - [#11337](https://togithub.com/sphinx-doc/sphinx/issues/11337): Fix a `MemoryError` in `sphinx.ext.intersphinx` when using `None` or `typing.*` as inline type references. Patch by Bénédikt Tran (picnixz) ## Testing - [#11345](https://togithub.com/sphinx-doc/sphinx/issues/11345): Always delete `docutils.conf` in test directories when running `SphinxTestApp.cleanup()`. ### [`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:`contentsConfiguration
📅 Schedule: Branch creation - "before 6am on Monday" in timezone 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 this update again.
This PR has been generated by Renovate Bot.