-
Notifications
You must be signed in to change notification settings - Fork 43
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
deps: update dependency sphinx to v7 #211
Conversation
468558d
to
ab539ce
Compare
the |
dde991f
to
6c82c51
Compare
6c82c51
to
f17366f
Compare
The sphinx read the docs theme released a new rc that supports sphinx v7: readthedocs/sphinx_rtd_theme#1463 (comment) |
e6b9c1b
to
e459119
Compare
Edited/Blocked NotificationRenovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR. You can manually request rebase by checking the rebase/retry box above. ⚠ Warning: custom changes will be lost. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The preview docs look good :) I am fine with going ahead with the RC if it unblocks the changes you wanted to make with regards to docstring vs type hints.
I will report back that our docs looks good after the upgrade. They said a release should be cut next week or so, and I am not in the rush. |
e459119
to
7c9e96f
Compare
This PR is upgrading sphinx as well as sphing-rtd-theme #290 |
This PR contains the following updates:
>=6.2.1,<7.0
->>=7.1.2,<7.2
Release Notes
sphinx-doc/sphinx (sphinx)
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 has been generated by Mend Renovate. View repository job log here.