feat(deps): update dependency sphinx to v7.3.7 #297
Merged
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}
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.1.2->7.3.7Release Notes
sphinx-doc/sphinx (Sphinx)
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.
v7.2.6Compare Source
=====================================
Bugs fixed
!SPHINX_AUTODOC_RELOAD_MODULESenvironment variable,which if set reloads modules when using autodoc with
TYPE_CHECKING = True.Patch by Matt Wozniski and Adam Turner.
importlib.reloadto reload modules in autodoc.Patch by Matt Wozniski and Adam Turner.
v7.2.5Compare Source
=====================================
Bugs fixed
packages that make use of
if typing.TYPE_CHECKING:to guard circularimports needed by type checkers.
Patch by Matt Wozniski.
for sibling files in a subdirectory.
Patch by Albert Shih.
?config=...in :confval:mathjax_path.when an object claims to be an instance of
type,but is not a class.
Patch by James Braza.
source-readevents for files read viathe :dudir:
includedirective.include-readfor observing and transformingthe content of included files via the :dudir:
includedirective.YYYYwhen
SOURCE_DATE_EPOCHis set.v7.2.4Compare Source
=====================================
Bugs fixed
introduced in #10478 (#9662).
and incorrect conversion from UTC to offsets from the UNIX epoch.
Patch by Dmitry Shachnev and Adam Turner.
v7.2.3Compare Source
=====================================
Dependencies
Bugs fixed
autodoc.Documenter.parse_name().classmethodmethodswhen
autodoc_preserve_defaultsisTrue.This is deprecated and will be removed in Sphinx 8.
Use :py:func:
os.fspathto convert :py:class:~pathlib.Pathobjects to strings,or :py:class:
~pathlib.Path's methods to work with path objects.v7.2.2Compare Source
=====================================
Bugs fixed
StateMachine.insert_input()patch,for when calling with keyword arguments.
in) for the :py:class:strinterfaceof the asset classes (
_CascadingStyleSheetand_JavaScript),which several extensions relied upon.
SingleFileHTMLBuilder._get_local_toctree,includehiddenmay be passed as a string or a boolean.:noindex:forPyModuleandJSModule.v7.2.1Compare Source
=====================================
Bugs fixed
strinterface of the asset classes(
_CascadingStyleSheetand_JavaScript),which several extensions relied upon.
This will be removed in Sphinx 9.
Builder.add_{css,js}_file(),which several extensions relied upon.
TocTree.get_toctree_ancestors(),which several extensions relied upon.
v7.2.0Compare Source
=====================================
Dependencies
Deprecated
sphinx.util.md5andsphinx.util.sha1.Use
hashlibinstead.sphinx.testing.path.Use
os.pathorpathlibinstead.sphinx.util.split_index_msgandsphinx.util.split_into.Use
sphinx.util.index_entries.split_index_msginstead.sphinx.builders.html.Stylesheetand
sphinx.builders.html.Javascript.Use
sphinx.application.Sphinx.add_css_file()and
sphinx.application.Sphinx.add_js_file()instead.sphinx.builders.html.StandaloneHTMLBuilder.css_filesandsphinx.builders.html.StandaloneHTMLBuilder.script_files.Use
sphinx.application.Sphinx.add_css_file()and
sphinx.application.Sphinx.add_js_file()instead.sphinx.ext.autodoc.preserve_defaults.get_function_def().Patch by Bénédikt Tran.
Features added
os.PathLiketypes andpathlib.Pathobjectsin many more places.
Patch by Jorge Leitao.
viewcode_line_numbersto controlwhether line numbers are added to rendered source code.
Patch by Ben Krikler.
:no-typesetting:option to suppress textual outputand only create a linkable anchor.
Patch by Latosha Maltba.
Patch by Rouslan Korneychuk.
doctest_show_successesoption.Patch by Trey Hunner.
:no-index:,:no-index-entry:, and:no-contents-entry:.debuglogging of reasons why files are detected as out ofdate.
Patch by Eric Larson.
source-readevents for files read viathe :dudir:
includedirective.Patch by Halldor Fannar.
585built-in generics.Patch by Riccardo Mori.
SigElementFallbackTransformfallback logic and signaturetext elements nodes. See :doc:
the documentation </extdev/nodes>for moredetails.
Patch by Bénédikt Tran.
python -m sphinx build ....Bugs fixed
Patch by Ralf Grubenmann.
Patch by Adrian Vollmer.
missing or broken links.
Patch by Albert Shih.
gettextbuilder.Patch by Alvin Wong.
graphviz_dotis falsy.with the
translated=Trueattribute.type comments
#: :meta ...:when using :mod:sphinx.ext.napoleon.Patch by Bénédikt Tran.
Patch by Dmitry Shachnev.
~typing.Literalenumerationvalues now render correctly.
Patch by Bénédikt Tran.
sphinx.ext.coverageextension.Patch by Stephen Finucane.
devices in the
agogotheme.Patch by Lukas Engelter.
sphinx.ext.autodoc.preserve_defaults.Patch by Bénédikt Tran.
Testing
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 has been generated by Mend Renovate. View repository job log here.