Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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:
^2.3.1->^4.0.0Release Notes
sphinx-doc/sphinx
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.
:py:meth:
domains.py.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'does 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_tuple:py:property:directive 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: autodoc: :confval:
autodoc_typehintsallows'both'setting toallow typehints to be included both in the signature and description
#4257: autodoc: Add :confval:
autodoc_class_signatureto separate the classentry and the definition of
__init__()method#8061, #9218: autodoc: Support variable comment for alias classes
#3014: autodoc: Add :event:
autodoc-process-basesto modify the base classesof the class definitions
#9272: autodoc: Render enum values for the default argument value better
#9384: autodoc:
autodoc_typehints='none'now erases typehints forvariables, attributes and properties
#3257: autosummary: Support instance attributes for classes
#9358: html: Add "heading" role to the toctree items
#9225: html: Add span tag to the return typehint of method/function
#9129: html search: Show search summaries when html_copy_source = False
#9307: html search: Prevent corrections and completions in search field
#9120: html theme: Eliminate prompt characters of code-block from copyable
text
#9176: i18n: Emit a debug message if message catalog file not found under
:confval:
locale_dirs#9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
#9016: linkcheck: Support checking anchors on github.com
#9016: linkcheck: Add a new event :event:
linkcheck-process-urito modifyURIs before checking hyperlinks
#6525: linkcheck: Add :confval:
linkcheck_allowed_redirectsto markhyperlinks that are redirected to expected URLs as "working"
#1874: py domain: Support union types using
|in info-field-list#9268: py domain: :confval:
python_use_unqualified_type_namessupports typefield in info-field-list
#9097: Optimize the parallel build
#9131: Add :confval:
nitpick_ignore_regexto ignore nitpicky warnings usingregular expressions
#9174: Add
Sphinx.set_html_assets_policyto tell extensions to includeHTML assets in all the pages. Extensions can check this via
Sphinx.registry.html_assets_policyC++, add support for
inlinevariables,constevalfunctions,constinitvariables,char8_t,explicit(<constant expression>)specifier,(e.g.,
Sortable auto &v).C, add support for digit separators in literals.
#9166: LaTeX: support containers in LaTeX output
Bugs fixed
undocumented
attribute not having any comment
rendered
class) via autoclass directive
:confval:
man_make_section_directoryis not correcton HEAD request
(e.g.
Callable[[], None])will be rendered with a bracket missing(
Callable[], None]):param:and:type:fields does not support a type containingwhitespace (ex.
Dict[str, str])making an single xref. For C and C++, use the
exprrole for typed fields.v4.0.3Compare Source
=====================================
Features added
_Decimal32,_Decimal64, and_Decimal128.c_extra_keywordsto allow user-defined keywordsduring parsing.
sphinx.util:force_decode()to become some 3rd partyextensions available again during 5.0
Bugs fixed
versionchangedwith contents being a listwill cause error during pdf build
with Japanese engines
See also :confval:
c_extra_keywords.v4.0.2Compare Source
=====================================
Dependencies
Incompatible changes
(see :confval:
man_make_section_directory)Bugs fixed
that does not support the node installs a missing-reference handler
v4.0.1Compare Source
=====================================
Bugs fixed
from a property of the class
autosummary_generate
cross-reference" warning
v4.0.0Compare Source
=====================================
Dependencies
4.0.0b1
tex-gyrefont dependency4.0.0b2
Some themes do not support it, and you need to update your custom CSS to
upgrade it.
Incompatible changes
4.0.0b1
autodoc_typehints='description'andautoclass_content='class'setIndexclass becomes subclasses ofabc.ABCto indicatemethods that must be overridden in the concrete classes
is added to indicate that the python object is canonical one
MathJax configuration may have to set the old MathJax path or update their
configuration for version 3. See :mod:
sphinx.ext.mathjax.napoleon_use_paramalso affect "other parameters"section
:confval:
man_make_section_directory):confval:
html_codeblock_linenos_styleto'inline'<p>instead of<div>basic/layout.html to
script_filesvariablecss_filesvariabledocuments
:var:,:cvar:and:ivar:fields do not createcross-references
alignattribute offigureandtablenodes becomesNoneby default instead of'default'some auxiliary files created in
latexbuild output repertorypath as a relative path from source directory
4.0.0b2
cpp:exprand:rst:role:
cpp:texpr.Deprecated
html_codeblock_linenos_stylefaviconandlogovariable in HTML templatessphinx.directives.patches.CSVTablesphinx.directives.patches.ListTablesphinx.directives.patches.RSTTablesphinx.ext.autodoc.directive.DocumenterBridge.filename_setsphinx.ext.autodoc.directive.DocumenterBridge.warn()sphinx.registry.SphinxComponentRegistry.get_source_input()sphinx.registry.SphinxComponentRegistry.source_inputssphinx.transforms.FigureAlignersphinx.util.pycompat.convert_with_2to3()sphinx.util.pycompat.execfile_()sphinx.util.smartypantssphinx.util.typing.DirectiveOptionFeatures added
4.0.0b1
boundargument for TypeVarwhen the class has two different names; a canonical name and an alias name
autodoc_typehints_description_targetto controlthe behavior of
autodoc_typehints=descriptionautodoc_docstring_signaturewill continue to lookfor multiple signature lines without backslash character
autosummary_generateby default:canonical:option to python directives to describethe location where the object is defined
python_use_unqualified_type_namesto suppressthe module name of the python reference if it can be resolved (experimental)
py:propertydirective to describe a property:confval:
gettext_additional_targetssetting)html_faviconand :confval:html_logonow accept URLfor the image
master_docis now renamed to :confval:root_doc<=>.sphinx.addnodes.pending_xref_conditionhas been added.It can be used to choose appropriate content of the reference by conditions.
4.0.0b2
Anyarguments causes nit-picky warningpy37+
alias objects are defined on the document
nodesfor details.mathjax_configto:confval:
mathjax2_configand add :confval:mathjax3_configBugs fixed
4.0.0b1
Python 3.7 or above)
<p>:unknown:doc:)cpp:enumeratorchange) with late TeXLive 2019
with size explicitly set in pixels) (fixed for
'pdflatex'/'lualatex'only)Pygments style
verbatimmaxunderfullsetting does not work asexpected
\pysigline\pysiglinewithargsretdoes not compute correctlyavailable horizontal space and should use a ragged right style
:confval:
cpp_index_common_prefixinstead of the first that matches.as parameter name.
function parameter lists.
(function) declarators, and in the argument to
sizeof....4.0.0b2
KeyErrorwhen analiasdirective is the first C/C++directive in a file with another C/C++ directive later.
4.0.0b3
v3.5.4=====================================
Dependencies
Bugs fixed
#9078: autodoc: Async staticmethods and classmethods are considered as non
async coroutine-functions with Python3.10
#8870, #9001, #9051: html theme: The style are not applied with docutils-0.17
sidebardirectivev3.5.3=====================================
Features added
v3.5.2Compare Source
=====================================
Bugs fixed
v3.5.1Compare Source
=====================================
Bugs fixed
read-only class
:confval:
html_contextunparsable python module found
v3.5.0Compare Source
=====================================
Dependencies
multicol(it is anyhow a required part of the official latex2ebase distribution)
Incompatible changes
html_add_permalinksis replaced by:confval:
html_permalinksand :confval:html_permalinks_iconDeprecated
sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignoresphinx.builders.linkcheck.CheckExternalLinksBuilder.authsphinx.builders.linkcheck.CheckExternalLinksBuilder.brokensphinx.builders.linkcheck.CheckExternalLinksBuilder.goodsphinx.builders.linkcheck.CheckExternalLinksBuilder.redirectedsphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueuesphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignoresphinx.builders.linkcheck.CheckExternalLinksBuilder.workerssphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueuesphinx.builders.linkcheck.node_line_or_0()sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()sphinx.ext.autodoc.directive.DocumenterBridge.reportersphinx.ext.autodoc.importer.get_module_members()sphinx.ext.autosummary.generate._simple_info()sphinx.ext.autosummary.generate._simple_warn()sphinx.writers.html.HTMLTranslator.permalink_textsphinx.writers.html5.HTML5Translator.permalink_textFeatures added
value of the variable if docstring contains
:meta hide-value:ininfo-field-list
implementation if they're ellipsis
autodoc_default_optionsviadirective options
autodoc_preserve_defaultsasan experimental feature. It preserves the default argument values of
functions in source code and keep them not evaluated for readability.
priorityparameterfor :meth:
Sphinx.add_js_file()and :meth:Sphinx.add_css_file()calls
app.add_js_file()orapp.add_css_file()on:event:
html-page-contextevent:confval:
html_permalinks_iconSnowball (v2.1.0)
type
:confval:
napoleon_custom_stylesreferences when :confval:
napoleon_preprocess_typesenabledproject_copyrightas an alias of :confval:copyrighthighlight_languagesupports multiple languagescode-blockand :rst:dir:literalincludesupports automaticdedent via no-argument
:dedent:optionmaxdepthoption to :rst:dir:cpp:aliasto insert nesteddeclarations.
norootoption to :rst:dir:c:aliasto render only nesteddeclarations.
norootoption to :rst:dir:cpp:aliasto render only nesteddeclarations.
Bugs fixed
class
:meta public:does not effect to variablescontains invalid type comments
undocumented
object that raises an exception on
hasattr():recursive: option
search language that does not split on +)
footnote reference
availability of the same URL twice
Configuration
📅 Schedule: 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 Renovate Bot.