This repository has been archived by the owner on May 10, 2023. It is now read-only.
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:
<3.0.0
-><6.1.4
Release Notes
sphinx-doc/sphinx
v6.1.3
Compare Source
=====================================
Bugs fixed
ValueError
in thelinkcheck
builderv6.1.2
Compare Source
=====================================
Bugs fixed
div.topic_padding
key of sphinxsetup documented at 5.1.0 wasimplemented with name
topic_padding
shadowrule
key of sphinxsetup causes PDF build to crashsince Sphinx 5.1.0
shadowsize
key of sphinxsetup causes PDF build to crashsince Sphinx 5.1.0
topic
and contents_ boxes not in pagemargin since Sphinx 5.1.0
v6.1.1
Compare Source
=====================================
Bugs fixed
util.nodes.apply_source_workaround
forliteral_block
nodeswith no source information in the node or the node's parents.
v6.1.0
Compare 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.util
functions:sphinx.util.typing.stringify()
to
sphinx.util.typing.stringify_annotation()
sphinx.util.xmlname_checker()
to
sphinx.builders.epub3._XML_NAME_PATTERN
Moved to
sphinx.util.display
:sphinx.util.status_iterator
sphinx.util.display_chunk
sphinx.util.SkipProgressMessage
sphinx.util.progress_message
Moved to
sphinx.util.http_date
:sphinx.util.epoch_to_rfc1123
sphinx.util.rfc1123_to_epoch
Moved to
sphinx.util.exceptions
:sphinx.util.save_traceback
sphinx.util.format_exception_cut_frames
Features added
X | Y
) display conventions fortyping.Optional
and
typing.Optional
types within the Python domain and autodoc.typing.NewType()
types as classes rather than'data'.
Bugs fixed
enum
module).TocTree.resolve()
through more efficient copying.to allow styling.
5.1.0
v6.0.1
Compare Source
=====================================
Dependencies
Bugs fixed
v6.0.0
Compare 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$u
global 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.jquery
to theextensions
list 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.js
andunderscore.js
fromthe Sphinx repository
_ to yourstatic
directory,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-apis
for 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_v3
andc_warn_on_allowed_pre_v3
. Patch by Adam Turner.Features added
See :confval:
latex_table_style
and thepre_border-radius
andpre_background-TeXcolor
:ref:additionalcss
for the former defaultsand how to re-enact them if desired.
Bugs fixed
latex_additional_files
behavior for fileswith
.tex
extension.v5.3.0
Compare Source
=====================================
latex_table_style
and support the'booktabs'
,'borderless'
, and'colorrows'
styles.(thanks to Stefan Wiehler for initial pull requests #6666, #6671)
:option:`--module=foobar```,
:option:--module[=foobar]``` or ``:option:
--module foobar```.Patch by Martin Liska.
directives (e.g. :rst:dir:
py:function
). Patch by Adam Turnerv5.2.3
Compare Source
=====================================
sphinx.ext.imgmath
:nocontentsentry:
flag and global domain table of contentsentry control option. Patch by Adam Turner
v5.2.2
Compare Source
=====================================
Patch by Dominic Davis-Foster.
v5.2.1
=====================================
Bugs fixed
pycon3
lexer topycon
.sphinx.ext.autosummary
with modules containing titles in themodule-level docstring.
v5.2.0.post0
===========================================
v5.2.0
Compare Source
===========================================
v5.1.1
Compare Source
=====================================
Bugs fixed
deque
basedsphinx.ext.napolean
iterator implementation.
v5.1.0
Compare Source
=====================================
Dependencies
Docutils 0.19
_. Patch by Adam Turner... _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05
Deprecated
sphinx.util.stemmer
in favour ofsnowballstemmer
.Patch by Adam Turner.
sphinx.ext.napoleon.iterators
.Features added
stylesheet
setting in
theme.conf
or by settinghtml_style
to an iterable of strings.option
directives through a new :confval:
option_emphasise_placeholders
configurationoption.
making whitespace issues easier to identify.
conf.py
file. Patch byPradyun Gedam.
'sphinxsetup' <latexsphinxsetup>
keys allow to configure four separate border-widths, four paddings, four
corner radii, a shadow (possibly inset), colours for border, background, shadow
for each of the code-block, topic, attention, caution, danger, error and warning
directives.
<aside>
element whenusing Docutils 0.18 or later, to allow for easier styling. This matches the
behaviour introduced in Docutils 0.19. Patch by Adam Turner.
include_patterns
as the opposite ofexclude_patterns
.Patch by Adam Turner.
Bugs fixed
to missing
Node.findall()
(refs: #10251)
+
,-
,~
, and**
). Patch by Adam Turner (refs: #10551).agogo.css_t
.on next page
\color
commands in topic or admonition boxes maycause color leaks in PDF due to upstream
framed.sty <https://ctan.org/pkg/framed>
_bug
diffs using Pygments style
'manni'
) inherit thickness of code-block frame\label
is generated fordesc_signature
nodeeven if it has multiple node IDs
using
:any:
and autodoc.v5.0.2
Compare Source
=====================================
Features added
variable,
docutils_version_info
. Patch by Adam Turner.Bugs fixed
if :confval:
autodoc_inherit_docstring
is disabledPatch by Adam Turner.
v5.0.1
Compare Source
=====================================
Bugs fixed
has no line number. Patch by Adam Turner.
topic
directive is rendered incorrectly withDocutils 0.18. Patch by Adam Turner.
kbd
role having a separator.Patch by Adam Turner.
v5.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.Patch by Adam Turner and Takeshi KOMIYA.
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/v5.3.0/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 %}
Patch by Adam Turner.
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. Patch by Adam Turner.
?:
).role
directive
Patch by Adam Turner.
Bugs fixed
5.0.0 b1
and .so files. Patch by Adam Turner and Takeshi KOMIYA.
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
v4.5.0
Compare Source
=====================================
Incompatible changes
:rst:role:
ref
roleDeprecated
sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()
Features added
FORCE_COLOR
andNO_COLOR
for terminal colouringextlinks_detect_hardcoded_links
to enablehardcoded links detector feature
:confval:
html_show_search_summary
to enable/disable the search summariesenable_search_shortcuts
that enables :kbd:/
asa Quick search shortcut and :kbd:
Esc
shortcut thatremoves search highlighting.
#noqa
comment to the tail of each translation message
pep
role now generates URLs based onpeps.python.org <https://peps.python.org>
_Bugs fixed
binary module
autodoc_default_options
does not supportno-value
optionunhashable object
[#named]
) that is referredmultiple times was rendered to a question mark
cpp:function
directive has big verticalspacing in Latexpdf
variables/structure members
the name is also used in the different document
ref
cross referencesstyle docstrings when :confval:
napoleon_use_ivar
is enabledcommand before showing help
v4.4.0
Compare Source
=====================================
Dependencies
importlib_metadata
for python-3.9 or oldersetuptools
Features added
autodoc_typehints_format
to suppress the leading module names of typehints of function signatures (ex.
io.StringIO
->StringIO
)__all__
attribute if :confval:autosummary_ignore_module_all
is set toFalse
. The default behaviour is unchanged. Autogen also now supportsthis behavior with the
--respect-module-all
switch.by an extlink, suggesting a replacement.
loading_method
parameter for :meth:
.Sphinx.add_js_file()
from URL
layout via CSS
.
and~
) as:type:
optionlinkcheck_exclude_documents
to disable linkchecking in matched documents.
and Python3.8+
-w
option giventarget name```) via :rst:role:
ref` rolesamp
roletexinfo_cross_references
to disable crossreferences for readability with standalone readers
external
for explictlookup in the external projects, without resolving to the local project.
Bugs fixed
with Python 3.10
position-only-arguments
autodoc_class_signature = 'separated'
override from conf.py
'xelatex'
line splitting at dashes ofinline and parsed literals
vertical spacing in latexpdf output
at info-field-list
directory
:dedent:
without argument did strip newlinesv4.3.2
Compare Source
=====================================
Bugs fixed
specifiers.
v4.3.1
Compare Source
=====================================
Features added
:confval:
mathjax_options
Bugs fixed
decorated by functools.lru_cache
having invalid doc attribute
:confval:
autodoc_preserve_defaults
enableddocutils-0.17
of MathJax is back to "async" method again
v4.3.0
Compare Source
=====================================
Dependencies
Incompatible changes
searchindex.js
: the embedded data has changed format to allowobjects with the same name in different domains.
with more docutils nodes to allow better CSS styling.
It may break existing styling.
domains.python.PyObject.get_signature_prefix
has changed toreturn a list of nodes instead of a plain string.
domains.js.JSObject.display_prefix
has been changed into a methodget_display_prefix
which now returns a list of nodesinstead of a plain string.
with more docutils nodes to allow better CSS styling.
It may break existing styling.
Deprecated
sphinx.ext.autodoc.AttributeDocumenter._datadescriptor
sphinx.writers.html.HTMLTranslator._fieldlist_row_index
sphinx.writers.html.HTMLTranslator._table_row_index
sphinx.writers.html5.HTML5Translator._fieldlist_row_index
sphinx.writers.html5.HTML5Translator._table_row_index
Features added
autodoc-process-bases
supports to inject reST snippet as abase class
retval
for :rst:dir:
c:function
and :rst:dir:c:macro
.retval
for :rst:dir:cpp:function
.gettext_allow_fuzzy_translations
to allow "fuzzy"messages for translation
add_stylesheet()
API. It will be kept untilthe Sphinx-6.0 release
intersphinx_disabled_reftypes
for disablinginterphinx resolution of cross-references that do not have an explicit
inventory specification. Specific types of cross-references can be disabled,
e.g.,
std:doc
or all cross-references in a specific domain,e.g.,
std:*
.warnings using :confval:
suppress_warnings
Bugs fixed
primary_domain
is not 'py'
:confval:
autodoc_typehints_description_target
is set to "documented" whenits info-field-list contains
:returns:
fieldgeneric class
autodoc_inherit_docstrings
does not effect tooverridden classmethods
autodoc_preserve_defaults
does not supporthexadecimal numeric
primary_domain
is not 'py'
return all of them as result instead of just one.
py:method
directive with
:property:
option:confval:
autodoc_typehints='description'
code
does not recognize:class:
optionbuild
e.g.,
proj:myFunc
, leave the inventory prefix in the unresolved text.v4.2.0
Compare Source
=====================================
Features added
3.10 or above
template variable
sphinx_version_tuple
py:property
directive supports:classmethod:
option to describe the class property
builddir
as an argumentBugs fixed
namespace package
class inherites the class having
_name
attributetyping
module are not displayedwell with the HEAD of 3.10
__init__()
and
__new__()
list[int]
)are not displayed well
are not removed completely
failed to fetch the content of the page
:type:
option for :rst:dir:py:property
directive doesnot create a hyperlink
function pointers.
language-highlighted
:code:
role.v4.1.2
Compare Source
=====================================
Incompatible changes
github.com (ex. anchors in reST/Markdown documents)
Bugs fixed
typing.NewType
are not displayed wellwith the HEAD of 3.10
typing
module are not displayed wellwith the HEAD of 3.10
autodoc_class_signature = "separated"
v4.1.1
Compare Source
=====================================
Dependencies
Bugs fixed
v4.1.0
Compare Source
=====================================
Dependencies
Deprecated
app
argument ofsphinx.environment.BuildEnvironment
becomesrequired
sphinx.application.Sphinx.html_theme
sphinx.ext.autosummary._app
sphinx.util.docstrings.extract_metadata()
Features added
#8107: autodoc: Add
class-doc-from
option to :rst:dir:autoclass
directive to control the content of the specific class like
:confval:
autoclass_content
#8588: autodoc: :confval:
autodoc_type_aliases
now supports dotted name. Itallows you to define an alias for a class with module name like
foo.bar.BazClass
#9175: autodoc: Special member is not documented in the module
#9195: autodoc: The arguments of
typing.Literal
are wrongly rendered[#9185](https://togith
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.