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.2.6
7.1.2
->7.2.6
3df4ab1
->8ade135
Release Notes
sphinx-doc/sphinx (Sphinx)
v7.2.6
Compare Source
=====================================
Bugs fixed
!SPHINX_AUTODOC_RELOAD_MODULES
environment variable,which if set reloads modules when using autodoc with
TYPE_CHECKING = True
.Patch by Matt Wozniski and Adam Turner.
importlib.reload
to reload modules in autodoc.Patch by Matt Wozniski and Adam Turner.
v7.2.5
Compare 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-read
events for files read viathe :dudir:
include
directive.include-read
for observing and transformingthe content of included files via the :dudir:
include
directive.YYYY
when
SOURCE_DATE_EPOCH
is set.v7.2.4
Compare 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.3
Compare Source
=====================================
Dependencies
Bugs fixed
autodoc.Documenter.parse_name()
.classmethod
methodswhen
autodoc_preserve_defaults
isTrue
.This is deprecated and will be removed in Sphinx 8.
Use :py:func:
os.fspath
to convert :py:class:~pathlib.Path
objects to strings,or :py:class:
~pathlib.Path
's methods to work with path objects.v7.2.2
Compare Source
=====================================
Bugs fixed
StateMachine.insert_input()
patch,for when calling with keyword arguments.
in
) for the :py:class:str
interfaceof the asset classes (
_CascadingStyleSheet
and_JavaScript
),which several extensions relied upon.
SingleFileHTMLBuilder._get_local_toctree
,includehidden
may be passed as a string or a boolean.:noindex:
forPyModule
andJSModule
.v7.2.1
Compare Source
=====================================
Bugs fixed
str
interface of the asset classes(
_CascadingStyleSheet
and_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.0
Compare Source
=====================================
Dependencies
Deprecated
sphinx.util.md5
andsphinx.util.sha1
.Use
hashlib
instead.sphinx.testing.path
.Use
os.path
orpathlib
instead.sphinx.util.split_index_msg
andsphinx.util.split_into
.Use
sphinx.util.index_entries.split_index_msg
instead.sphinx.builders.html.Stylesheet
and
sphinx.builders.html.Javascript
.Use
sphinx.application.Sphinx.add_css_file()
and
sphinx.application.Sphinx.add_js_file()
instead.sphinx.builders.html.StandaloneHTMLBuilder.css_files
andsphinx.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.PathLike
types andpathlib.Path
objectsin many more places.
Patch by Jorge Leitao.
viewcode_line_numbers
to 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_successes
option.Patch by Trey Hunner.
:no-index:
,:no-index-entry:
, and:no-contents-entry:
.debug
logging of reasons why files are detected as out ofdate.
Patch by Eric Larson.
source-read
events for files read viathe :dudir:
include
directive.Patch by Halldor Fannar.
585
built-in generics.Patch by Riccardo Mori.
SigElementFallbackTransform
fallback 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.
gettext
builder.Patch by Alvin Wong.
graphviz_dot
is falsy.with the
translated=True
attribute.type comments
#: :meta ...:
when using :mod:sphinx.ext.napoleon
.Patch by Bénédikt Tran.
Patch by Dmitry Shachnev.
~typing.Literal
enumerationvalues now render correctly.
Patch by Bénédikt Tran.
sphinx.ext.coverage
extension.Patch by Stephen Finucane.
devices in the
agogo
theme.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: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.