This repository has been archived by the owner on May 10, 2023. It is now read-only.
Update dependency sphinx to v6 #142
Open
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}
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.4Release Notes
sphinx-doc/sphinx
v6.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 contents_ boxes not in pagemargin 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.v5.3.0Compare Source
=====================================
latex_table_styleand 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.3Compare Source
=====================================
sphinx.ext.imgmath:nocontentsentry:flag and global domain table of contentsentry control option. Patch by Adam Turner
v5.2.2Compare Source
=====================================
Patch by Dominic Davis-Foster.
v5.2.1=====================================
Bugs fixed
pycon3lexer topycon.sphinx.ext.autosummarywith modules containing titles in themodule-level docstring.
v5.2.0.post0===========================================
v5.2.0Compare Source
===========================================
v5.1.1Compare Source
=====================================
Bugs fixed
dequebasedsphinx.ext.napoleaniterator implementation.
v5.1.0Compare 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.stemmerin favour ofsnowballstemmer.Patch by Adam Turner.
sphinx.ext.napoleon.iterators.Features added
stylesheetsetting in
theme.confor by settinghtml_styleto an iterable of strings.optiondirectives through a new :confval:
option_emphasise_placeholdersconfigurationoption.
making whitespace issues easier to identify.
conf.pyfile. 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_patternsas 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
\colorcommands 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\labelis generated fordesc_signaturenodeeven if it has multiple node IDs
using
:any:and autodoc.v5.0.2Compare Source
=====================================
Features added
variable,
docutils_version_info. Patch by Adam Turner.Bugs fixed
if :confval:
autodoc_inherit_docstringis disabledPatch by Adam Turner.
v5.0.1Compare Source
=====================================
Bugs fixed
has no line number. Patch by Adam Turner.
topicdirective is rendered incorrectly withDocutils 0.18. Patch by Adam Turner.
kbdrole having a separator.Patch by Adam Turner.
v5.0.0Compare 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 raisesImportExceptionGroupinstead ofImportErrorwhen 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=Falsekeyword argument until v7.0.@definfoenclosecommand was not supported because the command was deprecated since texinfo 6.8
intersphinx_disabled_reftypeshas 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_widthsetting in basic theme to 360px'en'if any language is not set inconf.py5.0.0 final
languagedoes not acceptNoneas it value. The defaultvalue of
languagebecomes 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$uglobal objects, you need to update yourJavaScript or use the mitigation below.
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:.. _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_sphinxsub-command for setup.py ismarked as deprecated to follow the policy of setuptools team.
The
localeargument ofsphinx.util.i18n:babel_format_date()becomesrequired
The
languageargument ofsphinx.util.i18n:format_date()becomesrequired
sphinx.builders.html.html5_readysphinx.io.read_doc()sphinx.util.docutils.__version_info__sphinx.util.docutils.is_html5_writer_available()sphinx.writers.latex.LaTeXWriter.docclassesFeatures added
5.0.0 b1
autodoc_typehints_formatischanged 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:
automoduledirectiveautodoc_typehints_description_targettoinclude undocumented return values but not undocumented parameters.
autodoc_typehints_formatnow also applies to attributes,data, properties, and type variable bounds.
non-imported
underscore.js) and modernised
doctools.jsandsearchtools.jstoEMCAScript 2018. Patch by Adam Turner.
?:).roledirective
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_signatureunexpectedly generatesreturn value typehint for constructors if docstring has multiple signatures
autodoc_preserve_defaultsdoes not work formixture of keyword only arguments with/without defaults
function
via :confval:
autodoc_type_aliasesautodoc_preserve_defaultsdoesn't work on classmethods
languagecontains a country code (ex. zh_CN)
@definfoenclosecommand onbulding texinfo document
too much vertical whitespace
?inpdf output
'howto'title page rule use\linewidthforcompatibility with usage of a
twocolumnclass option:prepend:option of :rst:dir:literalincludedirective does notwork with
:dedent:option5.0.0 final
autodoc_typehints="description"*argsand**kwargsentries 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.0Compare Source
=====================================
Incompatible changes
:rst:role:
refroleDeprecated
sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()Features added
FORCE_COLORandNO_COLORfor terminal colouringextlinks_detect_hardcoded_linksto enablehardcoded links detector feature
:confval:
html_show_search_summaryto enable/disable the search summariesenable_search_shortcutsthat enables :kbd:/asa Quick search shortcut and :kbd:
Escshortcut thatremoves search highlighting.
#noqacomment to the tail of each translation message
peprole now generates URLs based onpeps.python.org <https://peps.python.org>_Bugs fixed
binary module
autodoc_default_optionsdoes not supportno-valueoptionunhashable object
[#named]) that is referredmultiple times was rendered to a question mark
cpp:functiondirective has big verticalspacing in Latexpdf
variables/structure members
the name is also used in the different document
refcross referencesstyle docstrings when :confval:
napoleon_use_ivaris enabledcommand before showing help
v4.4.0Compare Source
=====================================
Dependencies
importlib_metadatafor python-3.9 or oldersetuptoolsFeatures added
autodoc_typehints_formatto suppress the leading module names of typehints of function signatures (ex.
io.StringIO->StringIO)__all__attribute if :confval:autosummary_ignore_module_allis set toFalse. The default behaviour is unchanged. Autogen also now supportsthis behavior with the
--respect-module-allswitch.by an extlink, suggesting a replacement.
loading_methodparameter for :meth:
.Sphinx.add_js_file()from URL
layout via CSS
.and~) as:type:optionlinkcheck_exclude_documentsto disable linkchecking in matched documents.
and Python3.8+
-woption giventarget name```) via :rst:role:ref` rolesamproletexinfo_cross_referencesto disable crossreferences for readability with standalone readers
externalfor 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.2Compare Source
=====================================
Bugs fixed
specifiers.
v4.3.1Compare Source
=====================================
Features added
:confval:
mathjax_optionsBugs fixed
decorated by functools.lru_cache
having invalid doc attribute
:confval:
autodoc_preserve_defaultsenableddocutils-0.17
of MathJax is back to "async" method again
v4.3.0Compare 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_prefixhas changed toreturn a list of nodes instead of a plain string.
domains.js.JSObject.display_prefixhas been changed into a methodget_display_prefixwhich 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._datadescriptorsphinx.writers.html.HTMLTranslator._fieldlist_row_indexsphinx.writers.html.HTMLTranslator._table_row_indexsphinx.writers.html5.HTML5Translator._fieldlist_row_indexsphinx.writers.html5.HTML5Translator._table_row_indexFeatures added
autodoc-process-basessupports to inject reST snippet as abase class
retvalfor :rst:dir:
c:functionand :rst:dir:c:macro.retvalfor :rst:dir:cpp:function.gettext_allow_fuzzy_translationsto allow "fuzzy"messages for translation
add_stylesheet()API. It will be kept untilthe Sphinx-6.0 release
intersphinx_disabled_reftypesfor disablinginterphinx resolution of cross-references that do not have an explicit
inventory specification. Specific types of cross-references can be disabled,
e.g.,
std:docor all cross-references in a specific domain,e.g.,
std:*.warnings using :confval:
suppress_warningsBugs fixed
primary_domainis not 'py'
:confval:
autodoc_typehints_description_targetis set to "documented" whenits info-field-list contains
:returns:fieldgeneric class
autodoc_inherit_docstringsdoes not effect tooverridden classmethods
autodoc_preserve_defaultsdoes not supporthexadecimal numeric
primary_domainis not 'py'
return all of them as result instead of just one.
py:methoddirective with
:property:option:confval:
autodoc_typehints='description'codedoes not recognize:class:optionbuild
e.g.,
proj:myFunc, leave the inventory prefix in the unresolved text.v4.2.0Compare Source
=====================================
Features added
3.10 or above
template variable
sphinx_version_tuplepy:propertydirective supports:classmethod:option to describe the class property
builddiras an argumentBugs fixed
namespace package
class inherites the class having
_nameattributetypingmodule 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:propertydirective doesnot create a hyperlink
function pointers.
language-highlighted
:code:role.v4.1.2Compare Source
=====================================
Incompatible changes
github.com (ex. anchors in reST/Markdown documents)
Bugs fixed
typing.NewTypeare not displayed wellwith the HEAD of 3.10
typingmodule are not displayed wellwith the HEAD of 3.10
autodoc_class_signature = "separated"v4.1.1Compare Source
=====================================
Dependencies
Bugs fixed
v4.1.0Compare Source
=====================================
Dependencies
Deprecated
appargument ofsphinx.environment.BuildEnvironmentbecomesrequired
sphinx.application.Sphinx.html_themesphinx.ext.autosummary._appsphinx.util.docstrings.extract_metadata()Features added
#8107: autodoc: Add
class-doc-fromoption to :rst:dir:autoclassdirective to control the content of the specific class like
:confval:
autoclass_content#8588: autodoc: :confval:
autodoc_type_aliasesnow 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.Literalare 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.