chore(deps): update dependency sphinx to v7 #458
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}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #458 +/- ##
=======================================
Coverage 92.04% 92.04%
=======================================
Files 52 52
Lines 2817 2817
=======================================
Hits 2593 2593
Misses 224 224
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
10 times, most recently
from
39a540c
to
7568003
Compare
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
10 times, most recently
from
7d7399b
to
a39e67d
Compare
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
8 times, most recently
from
5880b24
to
0814cb0
Compare
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
5 times, most recently
from
c7856bb
to
38ed299
Compare
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
18 times, most recently
from
20ad1ad
to
cac7241
Compare
⚠ 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 |
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
4 times, most recently
from
2699aa1
to
d8095f5
Compare
renovate
bot
force-pushed
the
renovate/sphinx-7.x
branch
from
d8095f5
to
4a82dba
Compare
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:
^5.2.1->^7.0.0Release Notes
sphinx-doc/sphinx (Sphinx)
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
v7.1.2Compare Source
=====================================
Bugs fixed
linkcheck_anchorsand do not spuriously report failures to validate anchors.
Patch by James Addison.
v7.1.1Compare Source
=====================================
Bugs fixed
SOURCE_DATE_EPOCHin multi-line copyright footer.Patch by Bénédikt Tran.
v7.1.0Compare 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:indexdirective, andset the removal version to Sphinx 9. Patch by Adam Turner.
Features added
generated HTML, using the CRC32 algorithm.
~sphinx.application.Sphinx.require_sphinxnow allows the versionrequirement to be specified as
(major, minor).:confval:
maximum_signature_line_lengthand 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_iteratornow clears the current linewith ANSI control codes, rather than overprinting with space characters.
Patch by James Addison.
translatedattribute on translated nodes.sphinx-build -Tin parallel builds. Patch by Bénédikt Tran
py:classand :rst:dir:py:functiondirectives 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_urlwhilestill 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-referenceclass that has been removed inthe latest (unreleased) version of Docutils.
#11486: Use :rfc:
8081font file MIME types in the EPUB builder.Using the correct MIME type will prevent warnings from
epubcheckand 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_prologis 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
MemoryErrorinsphinx.ext.intersphinxwhen usingNoneor
typing.*as inline type references. Patch by Bénédikt Tran (picnixz)Testing
docutils.confin test directories when runningSphinxTestApp.cleanup().v7.0.1Compare 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_commandfollowing the removal of support for setuptools.
Patch by Willem Mulder.
v7.0.0Compare Source
=====================================
Incompatible changes
MecabSplitterandDefaultSplitterinsphinx.search.ja.make_old_idfunctions in domain objectdescription classes.
build_sphinxhook insetup.py).sphinx.ext.napoleon.iteratorsmodule.jsdumpformat insphinx.search.localea required argument tosphinx.util.i18n.format_date().sphinx.util.stemmermodule.sphinx.pycode.ast.parse()function.sphinx.io.read_doc()function.sphinx.util.get_matching_files()function.sphinx.util.docutils.is_html5_writer_available()function.
envargument toBuildersubclasses required.stylekey for HTML templates.sphinx.writers.latex.LaTeXTranslator.docclassesattribute.
sphinx.builders.html.html5_readyandsphinx.builders.html.HTMLTranslatorattributes.v6.2.1Compare Source
=====================================
Bugs fixed
nitpick_ignoreand:confval:
nitpick_ignore_regextolist.v6.2.0Compare Source
=====================================
Dependencies
Incompatible changes
\dimenregisters (not previouslypublicly documented) as per 5.1.0 code comments in
sphinx.sty:\sphinxverbatimsep,\sphinxverbatimborder,\sphinxshadowsep,\sphinxshadowsize, and\sphinxshadowrule. (refs: #11105).eggsupport from pycodeModuleAnalyser; Python eggs are anow-obsolete binary distribution format
sphinx.builders.linkcheck.Patch by Daniel Eades
sphinx.locale.setlocaleDeprecated
intersphinx_mappingformatsphinx.util.osutil.cdis deprecated in favour ofcontextlib.chdir.Features added
autopropertyallows the return type to be specified asa type comment (e.g.,
# type: () -> int). Patch by Bénédikt Tran__all__to imported members for template renderingwhen option
autosummary_ignore_module_allis set toFalse. Patch byClement Pinard
content_offsetparameter tonested_parse_with_titles(),allowing for correct line numbers during nested parsing.
Patch by Jeremy Maitin-Shepard
--jobssynonym for-j. Patch by Hugo van Kemenade\sphinxboxfor styling text elements with a (possiblyrounded) box, optional background color and shadow, has been added.
See :ref:
sphinxbox. (refs: #11224)\sphinxstylenotetitle, ...,\sphinxstylewarningtitle, ...,for an extra layer of mark-up freeing up
\sphinxstrongfor other uses.See :ref:
latex-macros. (refs: #11267)note, :dudir:hint, :dudir:importantand :dudir:tipcannow 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)topic(and:dudir:
contents <table-of-contents>) directives, and not only:rst:dir:
code-block, supportbox-decoration-break=slice.noteTextColor,noteTeXextraset al.See :ref:
additionalcss.Patch by Jeremy Maitin-Shepard
imgmath_latex= 'tectonic'or= 'xelatex'. Patch by Dimitar Dimitrovpython_display_short_literal_typesoption forcondensed rendering of
Literaltypes.Bugs fixed
following lists
more reST labels directly precede an :rst:dir:
py:moduleor :rst:dir:automoduledirective. Patch by Bénédikt Tran (picnixz)
base name and they use a post transform. Patch by aaron-cooper
shadow color is set but border color is not
respective to contents (when using rounded corners)
\colorin topic (or admonition) contents may cause colorleak to the shadow and border at a page break
seealsodirective in French
indentation context in PDF. Thanks to picnixz.
\sphinxupquotecompatibility
other uses of
nested_parse_with_titles. Patch by Jeremy Maitin-Shepard.Patch by Jeremy Maitin-Shepard
txclientTesting
unittest.TestCasestyle test functions to pytest stylev6.1.3Compare Source
=====================================
Bugs fixed
ValueErrorin thelinkcheckbuilderv6.1.2Compare Source
=====================================
Bugs fixed
div.topic_paddingkey of sphinxsetup documented at 5.1.0 wasimplemented with name
topic_paddingshadowrulekey of sphinxsetup causes PDF build to crashsince Sphinx 5.1.0
shadowsizekey of sphinxsetup causes PDF build to crashsince Sphinx 5.1.0
topicand :dudir:contents <table-of-contents>boxes not in page margin since Sphinx 5.1.0
v6.1.1Compare Source
=====================================
Bugs fixed
util.nodes.apply_source_workaroundforliteral_blocknodeswith no source information in the node or the node's parents.
v6.1.0Compare Source
=====================================
Dependencies
Adopted the
Ruff_ code linter... _Ruff: https://github.com/charliermarsh/ruff
Incompatible changes
get_translation.This was unused and complicated other changes to
sphinx.locale.Deprecated
sphinx.utilfunctions:sphinx.util.typing.stringify()to
sphinx.util.typing.stringify_annotation()sphinx.util.xmlname_checker()to
sphinx.builders.epub3._XML_NAME_PATTERNMoved to
sphinx.util.display:sphinx.util.status_iteratorsphinx.util.display_chunksphinx.util.SkipProgressMessagesphinx.util.progress_messageMoved to
sphinx.util.http_date:sphinx.util.epoch_to_rfc1123sphinx.util.rfc1123_to_epochMoved to
sphinx.util.exceptions:sphinx.util.save_tracebacksphinx.util.format_exception_cut_framesFeatures added
X | Y) display conventions fortyping.Optionaland
typing.Optionaltypes within the Python domain and autodoc.typing.NewType()types as classes rather than'data'.
Bugs fixed
enummodule).TocTree.resolve()through more efficient copying.to allow styling.
5.1.0
v6.0.1Compare Source
=====================================
Dependencies
Bugs fixed
v6.0.0Compare Source
=====================================
Dependencies
Docutils 0.17 support. Patch by Adam Turner
Incompatible changes
#7405: Removed the jQuery and underscore.js JavaScript frameworks.
These frameworks are no longer be automatically injected into themes from
Sphinx 6.0. If you develop a theme or extension that uses the
jQuery,$, or$uglobal objects, you need to update yourJavaScript to modern standards, or use the mitigation below.
The first option is to use the sphinxcontrib.jquery_ extension, which has been
developed by the Sphinx team and contributors. To use this, add
sphinxcontrib.jqueryto theextensionslist inconf.py, or callapp.setup_extension("sphinxcontrib.jquery")if you develop a Sphinx themeor extension.
The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy
jquery.jsandunderscore.jsfromthe Sphinx repository_ to yourstaticdirectory,and add the following to your
layout.html:.. code-block:: html+jinja
{%- block scripts %} <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script> <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
{{ super() }}
{%- endblock %}
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
Patch by Adam Turner.
#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
:ref:
dev-deprecated-apisfor details. Patch by Adam Turner.#10901: C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables
c_allow_pre_v3andc_warn_on_allowed_pre_v3. Patch by Adam Turner.Features added
See :confval:
latex_table_styleand thepre_border-radiusandpre_background-TeXcolor:ref:additionalcssfor the former defaultsand how to re-enact them if desired.
Bugs fixed
latex_additional_filesbehavior for fileswith
.texextension.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 is behind base branch, 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.