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:
^4.0.0
->^5.0.0
^0.17.2
->^0.18.0
v2.0.3
->v3.0.0
Release Notes
sphinx-doc/sphinx
v5.0.1
Compare Source
=====================================
Bugs fixed
has no line number
topic
directive is rendered incorrectly withdocutils-0.18
kbd
role having a separatorv5.0.0
Compare Source
=====================================
Dependencies
5.0.0 b1
Docutils 0.18
_. Patch by Adam Turner... _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26
Incompatible changes
5.0.0 b1
sphinx.ext.autosummary.import_by_name()
now raisesImportExceptionGroup
instead ofImportError
when it failed to importtarget object. Please handle the exception if your extension uses the
function to import Python object. As a workaround, you can disable the
behavior via
grouped_exception=False
keyword argument until v7.0.@definfoenclose
command was not supported because the command was deprecated since texinfo 6.8
intersphinx_disabled_reftypes
has changed default valuefrom an empty list to
['std:doc']
as avoid too surprising silentintersphinx resolutions.
To migrate: either add an explicit inventory name to the references
intersphinx should resolve, or explicitly set the value of this configuration
variable to an empty list.
body_min_width
setting in basic theme to 360px'en'
if any language is not set inconf.py
5.0.0 final
language
does not acceptNone
as it value. The defaultvalue of
language
becomes to'en'
now.Deprecated
5.0.0 b1
#10028: jQuery and underscore.js will no longer be automatically injected into
themes from Sphinx 6.0. If you develop a theme or extension that uses the
jQuery
,$
, or$u
global objects, you need to update yourJavaScript or use the mitigation below.
To re-add jQuery and underscore.js, you will need to copy
jquery.js
andunderscore.js
fromthe Sphinx repository
_ to yourstatic
directory,and add the following to your
layout.html
:.. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v4.3.2/sphinx/themes/basic/static
.. 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 %}
setuptools integration. The
build_sphinx
sub-command for setup.py ismarked as deprecated to follow the policy of setuptools team.
The
locale
argument ofsphinx.util.i18n:babel_format_date()
becomesrequired
The
language
argument ofsphinx.util.i18n:format_date()
becomesrequired
sphinx.builders.html.html5_ready
sphinx.io.read_doc()
sphinx.util.docutils.__version_info__
sphinx.util.docutils.is_html5_writer_available()
sphinx.writers.latex.LaTeXWriter.docclasses
Features added
5.0.0 b1
autodoc_typehints_format
ischanged to
'smart'
. It will suppress the leading module names oftypehints (ex.
io.StringIO
->StringIO
).:inherited-members:
option now takes multiple classes. Itallows to suppress inherited members of several classes on the module at once
by specifying the option to :rst:dir:
automodule
directiveautodoc_typehints_description_target
toinclude undocumented return values but not undocumented parameters.
autodoc_typehints_format
now also applies to attributes,data, properties, and type variable bounds.
non-imported
underscore.js) and modernised
doctools.js
andsearchtools.js
toEMCAScript 2018.
?:
).role
directive
Bugs fixed
5.0.0 b1
and .so files
functions are rendered as a string literal
autodoc_docstring_signature
unexpectedly generatesreturn value typehint for constructors if docstring has multiple signatures
autodoc_preserve_defaults
does not work formixture of keyword only arguments with/without defaults
function
via :confval:
autodoc_type_aliases
autodoc_preserve_defaults
doesn't work on classmethods
language
contains a country code (ex. zh_CN)
@definfoenclose
command onbulding texinfo document
too much vertical whitespace
?
inpdf output
'howto'
title page rule use\linewidth
forcompatibility with usage of a
twocolumn
class option:prepend:
option of :rst:dir:literalinclude
directive does notwork with
:dedent:
option5.0.0 final
autodoc_typehints="description"
*args
and**kwargs
entries are duplicated whenautodoc_typehints="description"
not provide correct information
:meta:
fields are displayed if docstring contains twoor more meta-field
builder-finished event
executablebooks/MyST-Parser
v0.18.0
Compare Source
Full Changelog: v0.17.2...v0.18.0
This release adds support for Sphinx v5 (dropping v3), restructures the code base into modules, and also restructures the documentation, to make it easier for developers/users to follow.
It also introduces document-level configuration via the Markdown top-matter, under the
myst
key.See the Local configuration section for more information.
Breaking changes
This should not be breaking, for general users of the sphinx extension (with
sphinx>3
),but will be for anyone directly using the Python API, mainly just requiring changes in import module paths.
The
to_docutils
,to_html
,to_tokens
(frommyst_parser/main.py
) andmock_sphinx_env
/parse
(frommyst_parser.sphinx_renderer.py
) functions have been removed, since these were primarily for internal testing.Instead, for single page builds, users should use the docutils parser API/CLI (see ),
and for testing, functionality has been moved to https://github.com/chrisjsewell/sphinx-pytest.
The top-level
html_meta
andsubstitutions
top-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of themyst
config, e.g.pre-commit/action
v3.0.0
Compare Source
Breaking
see README for alternatives
Configuration
📅 Schedule: Branch creation - "before 3am on the first day of the month" (UTC), 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.
👻 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.