-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(deps): update dependency sphinx to v7 - autoclosed #309
Conversation
⚠ Artifact update problemRenovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is. ♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
The artifact failure details are included below: File name: poetry.lock
|
This remains on hold until readthedocs/sphinx_rtd_theme#1463 is resolved. |
03407c2
to
9373624
Compare
9373624
to
04ac01e
Compare
This comment has been minimized.
This comment has been minimized.
04ac01e
to
ab05a57
Compare
This comment has been minimized.
This comment has been minimized.
ab05a57
to
e12d734
Compare
This comment has been minimized.
This comment has been minimized.
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
e12d734
to
bfb9b8d
Compare
|
Packj Audit Report✅ No new dependencies are introducedTriggered by workflow run 43 on commit 14f0e9ac9f3d8ec6d118d41f2825a3fbaebd64bc |
This PR contains the following updates:
~6.2.1
->~7.4.0
Release Notes
sphinx-doc/sphinx (sphinx)
v7.4.7
Compare Source
=====================================
Bugs fixed
Patch by Adam Turner and Bénédikt Tran.
Patch by Adam Turner.
~typing.Annotated
typemetadata in the Python domain.
Patch by Adam Turner.
~typing.Annotated
warnings withsphinx.ext.autodoc
,especially when using :mod:
dataclasses
as type metadata.Patch by Adam Turner.
!autolink
.Patch by Adam Turner.
v7.4.6
Compare Source
=====================================
Bugs fixed
generating autosummary directives for modules within a package.
Patch by Adam Turner.
Patch by James Addison.
v7.4.5
Compare Source
=====================================
Bugs fixed
html_sidebars
values to a list.
Log an error message when string values are detected.
Patch by Adam Turner.
seealso
and other "light" admonitionsnow break PDF builds if they contain a :dudir:
figure
directive; and alsoif they are contained in a table cell (rendered by
tabulary
).Patch by Jean-François B.
v7.4.4
Compare Source
=====================================
Bugs fixed
case-insensitively ambiguous duplicate items.
Patch by James Addison.
v7.4.3
Compare Source
=====================================
Bugs fixed
source_suffix
valueswith extensions that register parsers.
Patch by Adam Turner.
v7.4.2
Compare Source
=====================================
Bugs fixed
with Sphinx 7.3.7 and earlier.
Patch by Adam Turner.
v7.4.1
Compare Source
=====================================
Bugs fixed
heading-level
is used.Patch by Adam Turner.
typing.ParamSpec
in autodoc.Patch by Adam Turner.
v7.4.0
Compare Source
=====================================
Dependencies
Patch by Adam Turner.
xcolor
package is now required (but is for example part ofUbuntu
texlive-latex-recommended
which has always been required).fontawesome5
LaTeX 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
iconpackage
key of :ref:'sphinxsetup' <latexsphinxsetup>
for more.Deprecated
sphinxlightbox
environment is not used anymore, all typesof admonitions use (by default) only
sphinxheavybox
.Features added
.. rst-class:: compact
#11165: Support the
officially recommended
_.jinja
suffix 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:label
andstd:term
references 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_alt
of built-in themes.Patch by Thomas Weißschuh
#12448: Add :option:
sphinx-apidoc --remove-old
option.Patch by Chris Sewell.
#12456: Add :option:
sphinx-autogen --remove-old
option.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.Unpack
Patch by Bénédikt Tran and Adam Turner.
#12524: Add a
class
option to the :rst:dir:toctree
directive.Patch by Tim Hoffmann.
#12536: Add the :rst:dir:
confval
directive.Patch by Adam Turner.
#12537: :confval:
c_id_attributes
, :confval:c_paren_attributes
,:confval:
cpp_id_attributes
, and :confval:cpp_paren_attributes
can 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_modules
to the coverage builderto allow explicitly specifying which modules should be documented.
Patch by Stephen Finucane.
#7896, #11989: Add a :rst:dir:
py:type
directive for documenting type aliases,and a :rst:role:
py:type
role for linking to them.Patch by Ashley Whetter.
#12549: Add optional
description
argument 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.Annotated
annotationswith their metadata in the Python domain.
Patch by Adam Turner and David Stansby.
#12506: Add
heading-level
option to :rst:dir:rubric
directive.Patch by Chris Sewell.
#12567: Add the :event:
write-started
event.Patch by Chris Sewell.
Bugs fixed
collections.abc.Callable
in 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 N
whenN
is alreadythe current page number.
Patch by Jean-François B.
'lualatex'
as :confval:latex_engine
use
babel
as with'xelatex'
(and notpolyglossia
).Patch by Jean-François B.
todolist
produce correct hyperlinks in PDF.Patch by Jean-François B.
when one value or the other is modified.
Patch by Bénédikt Tran.
en
locale.Patch by Nicolas Peugnet.
linkcheck_rate_limit_timeout
configuration 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.
695
formatting for LaTeX output.Patch by Bénédikt Tran.
Testing
Patch by James Addison.
v7.3.7
Compare 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.6
Compare Source
=====================================
Bugs fixed
Patch by Adam Turner.
sphinx.domains.python._annotations
in
sphinx.domains.python
.Patch by Jacob Chesslo and Adam Turner.
v7.3.5
Compare Source
=====================================
Bugs fixed
sphinx.domains.python._object
in
sphinx.domains.python
.Patch by Jacob Chesslo and Adam Turner.
v7.3.4
Compare Source
=====================================
Bugs fixed
Any
is not an instance oftype
.Patch by Adam Turner.
v7.3.3
Compare Source
=====================================
Bugs fixed
with
Any
as the valid type to a type other than the value's default.Patch by Adam Turner.
v7.3.2
Compare Source
=====================================
Bugs fixed
Patch by Adam Turner.
'Furo'
theme and the new-style forconfiguration values.
Patch by Adam Turner.
v7.3.1
Compare Source
=====================================
Dependencies
tomli
on Python 3.10 and earlier.Patch by Adam Turner.
v7.3.0
Compare 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-docutils
instead ofdocutils-stubs
.Deprecated
Makefile
and :file:make.bat
outputin :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._status
or :attr:
!sphinx.testing.util.SphinxTestApp._warning
is deprecated. Usethe public properties :attr:
!sphinx.testing.util.SphinxTestApp.status
and :attr:
!sphinx.testing.util.SphinxTestApp.warning
instead.Patch by Bénédikt Tran.
!sphinx.testing.util.strip_escseq
is 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-build
options 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:
versionremoved
directive.Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach.
#11981: Improve rendering of signatures using
slice
syntax,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:
versionadded
directive fromNew in [...]
toAdded in [...]
.Patch by Bénédikt Tran.
#12131: Added :confval:
show_warning_types
configuration option.Patch by Chris Sewell.
#12193: Improve
external
warnings 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
setup
function.Patch by Chris Sewell.
Bugs fixed
#11668: Raise a useful error when
theme.conf
is missing.Patch by Vinay Sajip.
#11622: Ensure that the order of keys in
searchindex.js
is 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
ZeroDivisionError
insphinx.ext.coverage
.Patch by Stephen Finucane.
#11756: LaTeX: build error with recent TeXLive due to missing
substitutefont
package (triggered if using
fontenc
withT2A
option 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_verify
andtls_cacerts
config toImageDownloader
.Patch by Nick Touran.
Allow hyphens in group names for :rst:dir:
productionlist
cross-references.Patch by Adam Turner.
#11433: Added the :confval:
linkcheck_allow_unauthorized
configuration option.Set this option to
False
to report HTTP 401 (unauthorized) serverresponses as broken.
Patch by James Addison.
#11868: linkcheck: added a distinct
timeout
reporting status code.This can be enabled by setting :confval:
linkcheck_report_timeouts_as_broken
to
False
.Patch by James Addison.
#11869: Refresh the documentation for the
linkcheck_timeout
setting.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
TemplateNotFound
exceptions.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
sphinxprettysearchresults
extension; 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:label
names 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:
numfig
isTrue
.Patch by Bénédikt Tran.
#11278: autodoc: Fix rendering of :class:
functools.singledispatchmethod
combined 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#foo
becomes
#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.sphinx
and :class:!sphinx.testing.util.SphinxTestApp
accept warningiserror, keep_going and verbosity as keyword arguments.
Patch by Bénédikt Tran.
!sphinx.testing.util.SphinxTestApp
status and warningarguments are checked to be :class:
io.StringIO
objects (the public APIincorrectly assumed this without checking it).
Patch by Bénédikt Tran.
test_run_epubcheck
asskipped
instead ofsuccess
when either Java orepubcheck
are not available.As a side-effect, this removes the need for test server lockfiles,
meaning that any remaining
tests/test-server.lock
files can safely bedeleted.
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
v7.1.2
Compare Source
=====================================
Bugs fixed
linkcheck_anchors
and do not spuriously report failures to validate anchors.
Patch by James Addison.
v7.1.1
Compare Source
=====================================
Bugs fixed
SOURCE_DATE_EPOCH
in multi-line copyright footer.Patch by Bénédikt Tran.
v7.1.0
Compare Source
=====================================
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
(namely,
module
,keyword
,operator
,object
,exception
,statement
, andbuiltin
) in the :rst:dir:index
directive, andset the removal version to Sphinx 9. Patch by Adam Turner.
Features added
generated HTML, using the CRC32 algorithm.
~sphinx.application.Sphinx.require_sphinx
now allows the versionrequirement to be specified as
(major, minor)
.: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.
Patch by Stefanie Molin
sphinx.util.display.status_iterator
now clears the current linewith ANSI control codes, rather than overprinting with space characters.
Patch by James Addison.
translated
attribute on translated nodes.sphinx-build -T
in parallel builds. Patch by Bénédikt Tran
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) 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.
via :confval:
linkcheck_anchors_ignore_for_url
whilestill checking the validity of the page itself.
Patch by Bénédikt Tran
via a new substitution (
|translation progress|
) and a newconfiguration 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 inthe latest (unreleased) version of Docutils.
#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: Use microsecond-resolution timestamps for outdated file detection
in
BuildEnvironment.get_outdated_files
.#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: Fix a
MemoryError
insphinx.ext.intersphinx
when usingNone
or
typing.*
as inline type references. Patch by Bénédikt Tran (picnixz)Testing
docutils.conf
in test directories when runningSphinxTestApp.cleanup()
.v7.0.1
Compare Source
=====================================
Dependencies
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
sphinx.setup_command
following the removal of support for setuptools.
Patch by Willem Mulder.
v7.0.0
Compare Source
=====================================
Incompatible changes
MecabSplitter
andDefaultSplitter
insphinx.search.ja
.make_old_id
functions in domain objectdescription classes.
build_sphinx
hook insetup.py
).sphinx.ext.napoleon.iterators
module.jsdump
format insphinx.search
.locale
a required argument tosphinx.util.i18n.format_date()
.sphinx.util.stemmer
module.sphinx.pycode.ast.parse()
function.sphinx.io.read_doc()
function.sphinx.util.get_matching_files()
function.sphinx.util.docutils.is_html5_writer_available()
function.
env
argument toBuilder
subclasses required.style
key for HTML templates.sphinx.writers.latex.LaTeXTranslator.docclasses
attribute.
sphinx.builders.html.html5_ready
andsphinx.builders.html.HTMLTranslator
attributes.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.