Update dependency Sphinx to ~=7.4.7 #719
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
3aae44f
to
2f9179a
Compare
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
2f9179a
to
7b81fda
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
7b81fda
to
9b0f570
Compare
renovate
bot
changed the title
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
2 times, most recently
from
d45405a
to
df70500
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
df70500
to
c346b32
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
c346b32
to
c160007
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
c160007
to
2c9bd6e
Compare
renovate
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
~=7.2.6->~=7.4.7Release Notes
sphinx-doc/sphinx (Sphinx)
v7.4.7Compare Source
=====================================
Bugs fixed
Patch by Adam Turner and Bénédikt Tran.
Patch by Adam Turner.
~typing.Annotatedtypemetadata in the Python domain.
Patch by Adam Turner.
~typing.Annotatedwarnings withsphinx.ext.autodoc,especially when using :mod:
dataclassesas type metadata.Patch by Adam Turner.
!autolink.Patch by Adam Turner.
v7.4.6Compare Source
=====================================
Bugs fixed
generating autosummary directives for modules within a package.
Patch by Adam Turner.
Patch by James Addison.
v7.4.5Compare Source
=====================================
Bugs fixed
html_sidebarsvalues to a list.
Log an error message when string values are detected.
Patch by Adam Turner.
seealsoand other "light" admonitionsnow break PDF builds if they contain a :dudir:
figuredirective; and alsoif they are contained in a table cell (rendered by
tabulary).Patch by Jean-François B.
v7.4.4Compare Source
=====================================
Bugs fixed
case-insensitively ambiguous duplicate items.
Patch by James Addison.
v7.4.3Compare Source
=====================================
Bugs fixed
source_suffixvalueswith extensions that register parsers.
Patch by Adam Turner.
v7.4.2Compare Source
=====================================
Bugs fixed
with Sphinx 7.3.7 and earlier.
Patch by Adam Turner.
v7.4.1Compare Source
=====================================
Bugs fixed
heading-levelis used.Patch by Adam Turner.
typing.ParamSpecin autodoc.Patch by Adam Turner.
v7.4.0Compare Source
=====================================
Dependencies
Patch by Adam Turner.
xcolorpackage is now required (but is for example part ofUbuntu
texlive-latex-recommendedwhich has always been required).fontawesome5LaTeX package is needed for the default choicesof icons now used in admonition titles in PDF output; but if unavailable the
PDF build will simply silently omit rendering such icons. Check the
documentation of the
iconpackagekey of :ref:'sphinxsetup' <latexsphinxsetup>for more.Deprecated
sphinxlightboxenvironment is not used anymore, all typesof admonitions use (by default) only
sphinxheavybox.Features added
.. rst-class:: compact
#11165: Support the
officially recommended_.jinjasuffix for templatefiles.
Patch by James Addison and Adam Turner
.. _officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension
#12325: Flatten
Union[Literal[T], Literal[U], ...]toLiteral[T, U, ...]when turning annotations into strings.
Patch by Adam Turner.
#12319:
sphinx.ext.extlinks: Addextlink-{name}CSS class to links.Patch by Hugo van Kemenade.
#12387: Improve CLI progress message, when copying assets.
Patch by INADA Nakoi and Bénédikt Tran.
#12361: Add :attr:
.BuildEnvironment.parser.Patch by Chris Sewell.
#12358: Add :attr:
.Sphinx.fresh_env_used.Patch by Chris Sewell.
#12329: Add detection of ambiguous
std:labelandstd:termreferences duringloading and resolution of Intersphinx targets.
Patch by James Addison.
#12422: Do not duplicate "navigation" in aria-label of built-in themes.
Patch by Thomas Weißschuh
#12421: Include project name in
logo_altof built-in themes.Patch by Thomas Weißschuh
#12448: Add :option:
sphinx-apidoc --remove-oldoption.Patch by Chris Sewell.
#12456: Add :option:
sphinx-autogen --remove-oldoption.Patch by Chris Sewell.
#12479: Add warning subtype
toc.no_title.Patch by Ondřej Navrátil.
#12492: Add helper methods for parsing reStructuredText content into nodes from
within a directive.
~sphinx.util.docutils.SphinxDirective.parse_content_to_nodes()parses the directive's content and returns a list of Docutils nodes.
~sphinx.util.docutils.SphinxDirective.parse_text_to_nodes()parses the provided text and returns a list of Docutils nodes.
~sphinx.util.docutils.SphinxDirective.parse_inline()parses the provided text into inline elements and text nodes.
Patch by Adam Turner.
#12258: Support
typing_extensions.UnpackPatch by Bénédikt Tran and Adam Turner.
#12524: Add a
classoption to the :rst:dir:toctreedirective.Patch by Tim Hoffmann.
#12536: Add the :rst:dir:
confvaldirective.Patch by Adam Turner.
#12537: :confval:
c_id_attributes, :confval:c_paren_attributes,:confval:
cpp_id_attributes, and :confval:cpp_paren_attributescan now be a tuple of strings.
:confval:
c_extra_keywords, :confval:gettext_additional_targets,:confval:
html_domain_indices, :confval:latex_domain_indices,and :confval:
texinfo_domain_indices,can now be a set of strings.
Patch by Adam Turner.
#12523: Added configuration option, :confval:
math_numsep, to define theseparator for math numbering.
Patch by Thomas Fanning
#11592: Add :confval:
coverage_modulesto the coverage builderto allow explicitly specifying which modules should be documented.
Patch by Stephen Finucane.
#7896, #11989: Add a :rst:dir:
py:typedirective for documenting type aliases,and a :rst:role:
py:typerole for linking to them.Patch by Ashley Whetter.
#12549: Add optional
descriptionargument to:meth:
.Sphinx.add_config_value.Patch by Chris Sewell.
#6792: Prohibit module import cycles in :mod:
sphinx.ext.autosummary.Patch by Trevor Bekolay.
#12508: LaTeX: Revamped styling of all admonitions, with addition of a
title row with icon.
Patch by Jean-François B.
#11773: Display :py:class:
~typing.Annotatedannotationswith their metadata in the Python domain.
Patch by Adam Turner and David Stansby.
#12506: Add
heading-leveloption to :rst:dir:rubricdirective.Patch by Chris Sewell.
#12567: Add the :event:
write-startedevent.Patch by Chris Sewell.
Bugs fixed
collections.abc.Callablein annotations.Patch by Adam Turner.
been present since version 3.0.0.
Patch by Donald Hunter.
Patch by Will Lachance.
merge_domaindata()insphinx.ext.duration.Patch by Matthias Geier.
Patch by Benjamin Cabé.
Page NwhenNis alreadythe current page number.
Patch by Jean-François B.
'lualatex'as :confval:latex_engineuse
babelas with'xelatex'(and notpolyglossia).Patch by Jean-François B.
todolistproduce correct hyperlinks in PDF.Patch by Jean-François B.
when one value or the other is modified.
Patch by Bénédikt Tran.
enlocale.Patch by Nicolas Peugnet.
linkcheck_rate_limit_timeoutconfiguration setting.
Patch by James Addison.
builders without native support for data-URIs in their output format.
Patch by James Addison.
(regression in 7.1.0).
Patch by Nicolas Peugnet.
removing duplication of search results.
Patch by James Addison.
and remove Sphinx's custom logic.
Patch by Tunç Başar Köse.
titles tend to rank higher than subsection titles. In addition, boost matches
on the name of programming domain objects relative to title/subtitle matches.
Patch by James Addison and Will Lachance.
Patch by Alvin Wong.
in the same order as defined in the document.
Previously, each domain used language-specific nesting rules,
which removed control from document authors.
Patch by Jakob Lykke Andersen and Adam Turner.
Patch by James Addison.
695formatting for LaTeX output.Patch by Bénédikt Tran.
Testing
Patch by James Addison.
v7.3.7Compare Source
=====================================
Bugs fixed
their explicit use by the user or a child theme.
Patch by Adam Turner.
theme.get_config()withan unsupported theme configuration section.
Patch by Adam Turner.
v7.3.6Compare Source
=====================================
Bugs fixed
Patch by Adam Turner.
sphinx.domains.python._annotationsin
sphinx.domains.python.Patch by Jacob Chesslo and Adam Turner.
v7.3.5Compare Source
=====================================
Bugs fixed
sphinx.domains.python._objectin
sphinx.domains.python.Patch by Jacob Chesslo and Adam Turner.
v7.3.4Compare Source
=====================================
Bugs fixed
Anyis not an instance oftype.Patch by Adam Turner.
v7.3.3Compare Source
=====================================
Bugs fixed
with
Anyas the valid type to a type other than the value's default.Patch by Adam Turner.
v7.3.2Compare Source
=====================================
Bugs fixed
Patch by Adam Turner.
'Furo'theme and the new-style forconfiguration values.
Patch by Adam Turner.
v7.3.1Compare Source
=====================================
Dependencies
tomlion Python 3.10 and earlier.Patch by Adam Turner.
v7.3.0Compare Source
=====================================
Dependencies
#11858: Increase the minimum supported version of Alabaster to 0.7.14.
Patch by Adam Turner.
#11411: Support
Docutils 0.21_. Patch by Adam Turner... _Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09
#12012: Use
types-docutilsinstead ofdocutils-stubs.Deprecated
Makefileand :file:make.batoutputin :program:
sphinx-quickstart, and the associated options :option:!-M,:option:
!-m, :option:!--no-use-make-mode, and :option:!--use-make-mode.!sphinx.testing.util.SphinxTestApp._statusor :attr:
!sphinx.testing.util.SphinxTestApp._warningis deprecated. Usethe public properties :attr:
!sphinx.testing.util.SphinxTestApp.statusand :attr:
!sphinx.testing.util.SphinxTestApp.warninginstead.Patch by Bénédikt Tran.
!sphinx.testing.util.strip_escseqis deprecated in favour of:func:
!sphinx.util.console.strip_colors.Patch by Bénédikt Tran.
Features added
#12265: Support theme configuration via
theme.toml.#11701: HTML Search: Adopt the new
\<search\>_ element.Patch by Bénédikt Tran.
.. _
\<search\>: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search#11776: Add long option names to
sphinx-build.Patch by Hugo van Kemenade, Adam Turner, Bénédikt Tran, and Ezio Melotti.
Organise the
sphinx-buildoptions into groups.Patch by Adam Turner.
#11855: Defer computation of configuration values.
Patch by Adam Turner.
Add
:no-search:as an alias of the:nosearch:metadata field.Patch by Adam Turner.
#11803: autodoc: Use an overriden
__repr__()function in an enum,if defined. Patch by Shengyu Zhang.
#11825: Allow custom targets in the manpage role.
Patch by Nicolas Peugnet.
#11892: Improved performance when resolving cross references in the C++ domain.
Patch by Rouslan Korneychuk.
#11905: Add a :rst:dir:
versionremoveddirective.Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach.
#11981: Improve rendering of signatures using
slicesyntax,e.g.,
def foo(arg: np.float64[:,:]) -> None: ....The manpage builder now adds
OSC 8_ anchors to hyperlinks, usingthe
groff_ device control command... _OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
.. _groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html
#11015: Change the text of the :rst:dir:
versionaddeddirective fromNew in [...]toAdded in [...].Patch by Bénédikt Tran.
#12131: Added :confval:
show_warning_typesconfiguration option.Patch by Chris Sewell.
#12193: Improve
externalwarnings for unknown roles.In particular, suggest related role names if an object type is mistakenly used.
Patch by Chris Sewell.
Add public type alias :class:
sphinx.util.typing.ExtensionMetadata.This can be used by extension developers
to annotate the return type of their
setupfunction.Patch by Chris Sewell.
Bugs fixed
#11668: Raise a useful error when
theme.confis missing.Patch by Vinay Sajip.
#11622: Ensure that the order of keys in
searchindex.jsis deterministic.Patch by Pietro Albini.
#11617: ANSI control sequences are stripped from the output when writing to
a warnings file with :option:
-w <sphinx-build -w>.Patch by Bénédikt Tran.
#11666: Skip all hidden directories in
CatalogRepository.pofiles.Patch by Aryaz Eghbali.
#9686: html builder: Fix MathJax lazy loading when equations appear in titles.
Patch by Bénédikt Tran.
#11483: singlehtml builder: Fix MathJax lazy loading when the index does not
contain any math equations.
Patch by Bénédikt Tran.
#11697: HTML Search: add 'noindex' meta robots tag.
Patch by James Addison.
#11678: Fix a possible
ZeroDivisionErrorinsphinx.ext.coverage.Patch by Stephen Finucane.
#11756: LaTeX: build error with recent TeXLive due to missing
substitutefontpackage (triggered if using
fontencwithT2Aoption and documentlanguage is not a Cyrillic one).
Patch by Jean-François B.
#11675: Fix rendering of progression bars in environments that do not support
ANSI control sequences.
Patch by Bénédikt Tran.
#11861: Whitelist more types with an incorrect
__module__attribute.Patch by Adam Turner.
#11715: Apply
tls_verifyandtls_cacertsconfig toImageDownloader.Patch by Nick Touran.
Allow hyphens in group names for :rst:dir:
productionlistcross-references.Patch by Adam Turner.
#11433: Added the :confval:
linkcheck_allow_unauthorizedconfiguration option.Set this option to
Falseto report HTTP 401 (unauthorized) serverresponses as broken.
Patch by James Addison.
#11868: linkcheck: added a distinct
timeoutreporting status code.This can be enabled by setting :confval:
linkcheck_report_timeouts_as_brokento
False.Patch by James Addison.
#11869: Refresh the documentation for the
linkcheck_timeoutsetting.Patch by James Addison.
#11874: Configure a default 30-second value for
linkcheck_timeout.Patch by James Addison.
#11886: Print the Jinja2 template path chain in
TemplateNotFoundexceptions.Patch by Colin Marquardt.
#11598: Do not use query components in URLs for assets in EPUB rendering.
Patch by David Runge.
#11904: Support unary subtraction when parsing annotations.
Patch by James Addison.
#11925: Blacklist the
sphinxprettysearchresultsextension; the functionalityit provides was merged into Sphinx v2.0.0.
Patch by James Addison.
#11917: Fix rendering of annotated inherited members for Python 3.9.
Patch by Janet Carson.
#11935: C Domain: Fix namespace-pop context.
Patch by Frank Dana.
#11923: Avoid zombie processes when parallel builds fail.
Patch by Felix von Drigalski.
#11353: Support enumeration classes inheriting from mixin or data types.
Patch by Bénédikt Tran.
#11962: Fix target resolution when using
:paramtype:fields.Patch by Bénédikt Tran.
#11944: Use anchor in search preview.
Patch by Will Lachance.
#12008: Fix case-sensitive lookup of
std:labelnames in intersphinx inventory.Patch by Michael Goerz.
#11958: HTML Search: Fix partial matches overwriting full matches.
Patch by William Lachance.
#11959: Fix multiple term matching when word appears in both title and document.
Patch by Will Lachance.
#11474: Fix doctrees caching causing files not be rebuilt in some cases,
e.g., when :confval:
numfigisTrue.Patch by Bénédikt Tran.
#11278: autodoc: Fix rendering of :class:
functools.singledispatchmethodcombined with :func:
@classmethod <classmethod>.Patch by Bénédikt Tran.
#11894: Do not add checksums to css files if building using the htmlhelp builder.
Patch by reduerK akiM.
#12052: Remove
<script>and<style>tags from the content of search resultsummary snippets.
Patch by James Addison.
#11578: HTML Search: Order non-main index entries after other results.
Patch by Brad King.
#12147: autosummary: Fix a bug whereby the wrong file extension
may be used,
when multiple suffixes are specified in :confval:
source_suffix.Patch by Sutou Kouhei.
#10786: improve the error message when a file to be copied (e.g., an asset)
is removed during Sphinx execution.
Patch by Bénédikt Tran.
#12040: HTML Search: Ensure that document titles that are partially-matched by
the user search query are included in search results.
Patch by James Addison.
#11970: singlehtml builder: make target URIs to be same-document references in
the sense of :rfc:
RFC 3986, §4.4 <3986#section-4.4>, e.g.,index.html#foobecomes
#foo. Patch by Eric Norige.#12271: Partially revert Docutils' r9562__ to fix EPUB files.
Patch by Adam Turner.
__ https://sourceforge.net/p/docutils/code/9562/
#12253: Escape reserved path characters in the remote images post-transform
download cache.
Patch by James Addison and Adam Turner.
Testing
Patch by Adam Turner.
SphinxTestApp.Patch by Adam Turner.
!pytest.mark.sphinxand :class:!sphinx.testing.util.SphinxTestAppaccept warningiserror, keep_going and verbosity as keyword arguments.
Patch by Bénédikt Tran.
!sphinx.testing.util.SphinxTestAppstatus and warningarguments are checked to be :class:
io.StringIOobjects (the public APIincorrectly assumed this without checking it).
Patch by Bénédikt Tran.
test_run_epubcheckasskippedinstead ofsuccesswhen either Java orepubcheckare not available.As a side-effect, this removes the need for test server lockfiles,
meaning that any remaining
tests/test-server.lockfiles can safely bedeleted.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), 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 was generated by Mend Renovate. View the repository job log.