chore(deps): update dependency sphinx to v4 #1450
Conversation
c21d7ac to
97cf1a5
Compare
|
Seems like this slightly breaks formatting from a quick local comparison:
Maybe an opportunity to refresh it with a more modern theme :P |
|
@nejch Nice job noticing. If a new theme will fix the problem it sounds reasonable to me. |
It's really a minor thing, but I might have a look on the weekend just for fun :) I've looked at Furo before (where I don't like that there's no dark/light toggle as the dark mode doesn't work that well for code snippets IMO pradyunsg/furo#24) and sphinx-material which is also nice and looks familiar to people using mkdocs. (both are pretty much drop-in replacements with a one line change) |
97cf1a5 to
e1516d6
Compare
e1516d6 to
dddcba8
Compare
dddcba8 to
868945a
Compare
e08be6d to
4a9ca3e
Compare
4a9ca3e to
7f762f5
Compare
7f762f5 to
2e0432d
Compare
Codecov Report
@@ Coverage Diff @@
## master #1450 +/- ##
==========================================
- Coverage 91.16% 82.30% -8.86%
==========================================
Files 74 74
Lines 4177 4177
==========================================
- Hits 3808 3438 -370
- Misses 369 739 +370
Flags with carried forward coverage won't be shown. Click here to find out more.
|
2e0432d to
73745f7
Compare
|
I'll merge this since it's needed to support python 3.10, we can sort out the theme quirks in a follow-up (or change the theme). |
This PR contains the following updates:
==3.5.4->==4.2.0Release Notes
sphinx-doc/sphinx
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
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 WhiteSource Renovate. View repository job log here.