Update dependency Sphinx to v1.8.6 #3
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}
renovate
bot
changed the title
renovate
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
==1.1.2->==1.8.6Release Notes
sphinx-doc/sphinx (Sphinx)
v1.8.6Compare Source
=====================================
Dependencies
v1.8.5Compare Source
=====================================
Bugs fixed
#6004)
TypeErroris raised when invalid latex_elements given:index:role in titles causesUse of \@​icentercr doesn't match its definitionerror on latexpdf buildautofunctionemits a warning for method objectsskipifoption may remove the code block from documentation:name:option formathdirective causes a crashv1.8.4Compare Source
=====================================
Bugs fixed
be searched.
numfig_formatis stripped of spaces and may causebuild failure
constraints in the return type.
in an admonition
:scale:image option may break PDF build if image in an admonition:file:
parskip.sty.is not allowedv1.8.3Compare Source
=====================================
Features added
page, see discussion of
'maketitle'key of :confval:latex_elements(
'manual'docclass only)Bugs fixed
/latex(refs: #1238)
\maketitleis overwritten with nopossibility to use original meaning in place of Sphinx custom one
--tocfilev1.8.2Compare Source
=====================================
Incompatible changes
Features added
Bugs fixed
\labelpositioning for figures with a legend#4821)
functools.partialduplicated node_ids
builder crash
v1.8.1Compare Source
=====================================
Incompatible changes
\pagestylecommands have been moved to the LaTeX template. Nochanges in PDF, except possibly if
\sphinxtableofcontents, whichcontained them, had been customized in :file:
conf.py. (refs: #5455)Bugs fixed
autodoc_default_flagsautofunctionemits a warning for callable objects:type:field can't process:term:referencesv1.8.0Compare Source
=====================================
Dependencies
1.8.0b1
latex_use_xindy, ifTrue(default forxelatex/lualatex), instructsmake latexpdfto use :program:xindyfor general index. Make sure your LaTeX distribution includes it.
(refs: #5134)
latexmkis required formake latexpdfon WindowsIncompatible changes
1.8.0b2
pygments_stylesettings of HTML themespreferentially
Makefileandmake.batare not overwritten if exists1.8.0b1
#5156: the :py:mod:
sphinx.ext.graphvizextension runsdotin thedirectory of the document being built instead of in the root directory of
the documentation.
#4460: extensions which stores any data to environment should return the
version of its env data structure as metadata. In detail, please see
:ref:
ext-metadata.Sphinx expects source parser modules to have supported file formats as
Parser.supportedattributeThe default value of :confval:
epub_authorand :confval:epub_publisherarechanged from
'unknown'to the value of :confval:author. This is same asa
conf.pyfile sphinx-build generates.The
gettext_compactattribute is removed fromdocument.settingsobject. Please use
config.gettext_compactinstead.The processing order on reading phase is changed. smart_quotes, sphinx
domains, :event:
doctree-readevent and versioning doctrees are invokedearlier than so far. For more details, please read a description of
:py:meth:
.Sphinx.add_transform()#4827: All
substitution_definitionnodes are removed from doctree onreading phase
docutils.confin$HOMEor/etcdirectories are ignored. Onlydocutils.conffrom confdir is obeyed.#789:
:samp:role supports to escape curly braces with backslash#4811: The files under :confval:
html_static_pathare excluded from sourcefiles.
latex: Use
\sphinxcitefor citation references instead\hyperrefThe config value :confval:
!viewcode_importis renamed to:confval:
viewcode_follow_imported_members(refs: #4035)#1857: latex: :confval:
latex_show_pagerefsdoes not add pagerefs forcitations
#4648: latex: Now "rubric" elements are rendered as unnumbered section title
#4983: html: The anchor for productionlist tokens has been changed
Modifying a template variable
script_filesin templates is allowed now.Please use
app.add_js_file()instead.#5072: Save environment object also with only new documents
#5035: qthelp builder allows dashes in :confval:
qthelp_namespaceLaTeX: with lualatex or xelatex use by default :program:
xindyasUTF-8 able replacement of :program:
makeindex(refs: #5134). Afterupgrading Sphinx, please clean latex build repertory of existing project
before new build.
#5163: html: hlist items are now aligned to top
highlightlangdirective is processed on resolving phase#4000: LaTeX: template changed. Following elements moved to it:
\begin{document}shorthandoffvariablemaketitlevariabletableofcontentsvariableDeprecated
1.8.0b2
sphinx.io.SphinxI18nReader.set_lineno_for_reporter()is deprecatedsphinx.io.SphinxI18nReader.lineis deprecatedsphinx.util.i18n.find_catalog_source_file()has changed; thegettext_compact argument has been deprecated
sphinx.util.images.guess_mimetype()has changed; the contentargument has been deprecated
1.8.0b1
source_parsersis deprecatedautodoc_default_flagsis deprecated--epuboption becomes default, so it is deprecatedbased directives (see :class:
~docutils.parsers.rst.Directive)sphinx.util.docutils.directive_helper()is deprecatedsphinx.cmdlineis deprecatedsphinx.make_modeis deprecatedsphinx.locale.l_()is deprecatedwarn()for HTML themes is deprecatedapp.override_domain()is deprecatedapp.add_stylesheet()is deprecatedapp.add_javascript()is deprecatedapp.import_object()is deprecatedapp.add_source_parser()has changed; the suffix argument has beendeprecated
sphinx.versioning.prepare()is deprecatedConfig.__init__()has changed; the dirname, filename and tagsargument has been deprecated
Config.check_types()is deprecatedConfig.check_unicode()is deprecatedsphinx.application.CONFIG_FILENAMEis deprecatedhighlightlangdirective is deprecatedBuildEnvironment.load()is deprecatedBuildEnvironment.loads()is deprecatedBuildEnvironment.frompickle()is deprecatedenv.read_doc()is deprecatedenv.update()is deprecatedenv._read_serial()is deprecatedenv._read_parallel()is deprecatedenv.write_doctree()is deprecatedenv._nitpick_ignoreis deprecatedenv.versionchangesis deprecatedenv.dump()is deprecatedenv.dumps()is deprecatedenv.topickle()is deprecatedenv.note_versionchange()is deprecatedsphinx.writers.latex.Table.caption_footnotetextsis deprecatedsphinx.writers.latex.Table.header_footnotetextsis deprecatedsphinx.writers.latex.LaTeXTranslator.footnotestackis deprecatedsphinx.writers.latex.LaTeXTranslator.in_container_literal_blockisdeprecated
sphinx.writers.latex.LaTeXTranslator.next_section_idsis deprecatedsphinx.writers.latex.LaTeXTranslator.next_hyperlink_idsis deprecatedsphinx.writers.latex.LaTeXTranslator.restrict_footnote()is deprecatedsphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()is deprecatedsphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()is deprecatedsphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()is deprecatedsphinx.writers.latex.LaTeXTranslator.check_latex_elements()is deprecatedsphinx.writers.latex.LaTeXTranslator.bibitemsis deprecatedsphinx.writers.latex.LaTeXTranslator.hlsettingstackis deprecatedsphinx.writers.latex.ExtBabel.get_shorthandoff()is deprecatedsphinx.writers.html.HTMLTranslator.highlightlangis deprecatedsphinx.writers.html.HTMLTranslator.highlightlang_baseis deprecatedsphinx.writers.html.HTMLTranslator.highlightlangoptsis deprecatedsphinx.writers.html.HTMLTranslator.highlightlinenothresholdis deprecatedsphinx.writers.html5.HTMLTranslator.highlightlangis deprecatedsphinx.writers.html5.HTMLTranslator.highlightlang_baseis deprecatedsphinx.writers.html5.HTMLTranslator.highlightlangoptsis deprecatedsphinx.writers.html5.HTMLTranslator.highlightlinenothresholdis deprecatedsphinx.ext.mathbaseextension is deprecatedsphinx.ext.mathbase.mathnode is deprecatedsphinx.ext.mathbase.displaymathnode is deprecatedsphinx.ext.mathbase.eqrefnode is deprecatedsphinx.ext.mathbase.is_in_section_title()is deprecatedsphinx.ext.mathbase.MathDomainis deprecatedsphinx.ext.mathbase.MathDirectiveis deprecatedsphinx.ext.mathbase.math_roleis deprecatedsphinx.ext.mathbase.setup_math()is deprecatedsphinx.directives.other.VersionChangesis deprecatedsphinx.highlighting.PygmentsBridge.unhighlight()is deprecatedsphinx.ext.mathbase.get_node_equation_number()is deprecatedsphinx.ext.mathbase.wrap_displaymath()is deprecatedtrim_doctest_flagsargument ofsphinx.highlighting.PygmentsBridgeis deprecated
For more details, see :ref:
deprecation APIs list <dev-deprecated-apis>.Features added
1.8.0b2
--tocfileoption to change the filename of ToC1.8.0b1
Add :event:
config-initedeventAdd
sphinx.config.Anyto represent the config value accepts any type ofvalue
:confval:
source_suffixallows a mapping fileext to file typesAdd :confval:
authoras a configuration value#2852: imgconverter: Support to convert GIF to PNG
sphinx-buildcommand supports i18n console outputAdd
app.add_message_catalog()andsphinx.locale.get_translations()tosupport translation for 3rd party extensions
helper function
warning()for HTML themes is addedAdd
Domain.enumerable_nodesto manage own enumerable nodes for domains(experimental)
Add a new keyword argument
overrideto Application APIsLaTeX: new key
'fvset'for :confval:latex_elements. ForXeLaTeX/LuaLaTeX its default sets
fanvyvrbto use normal, not small,fontsize in code-blocks (refs: #4793)
Add :confval:
html_css_filesand :confval:epub_css_filesfor adding CSSfiles from configuration
Add :confval:
html_js_filesfor adding JS files from configuration#4834: Ensure set object descriptions are reproducible.
#4828: Allow to override :confval:
numfig_formatpartially. Full definitionis not needed.
Improve warning messages during including (refs: #4818)
LaTeX: separate customizability of :rst:role:
guilabeland:rst:role:
menuselection(refs: #4830)Add
Config.read()classmethod to create a new config object fromconfiguration file
#4866: Wrap graphviz diagrams in
<div>tagviewcode: Add :event:
viewcode-find-sourceand:event:
viewcode-follow-importedto load source code without loading#4785: napoleon: Add strings to translation file for localisation
#4927: Display a warning when invalid values are passed to linenothreshold
option of highlight directive
C++:
cpp:texprrole as a sibling tocpp:expr.@.and now properly documented.
cpp:anyandcpp:funcroles, for referencing specific function overloads.
#3606: MathJax should be loaded with async attribute
html: Output
canonical_urlmetadata if :confval:html_baseurlset (refs:#4193)
#5029: autosummary: expose
inherited_membersto template#3784: mathjax: Add :confval:
mathjax_optionsto give options to script tagfor mathjax
#726, #969: mathjax: Add :confval:
mathjax_configto give in-lineconfigurations for mathjax
#4362: latex: Don't overwrite .tex file if document not changed
#1431: latex: Add alphanumeric enumerated list support
Add :confval:
latex_use_xindyfor UTF-8 savvy indexing, defaults toTrueif :confval:
latex_engineis'xelatex'or'lualatex'. (refs: #5134,#5192, #5212)
#4976:
SphinxLoggerAdapter.info()now supportslocationparameter#5122: setuptools: support nitpicky option
#2820: autoclass directive supports nested class
Add
app.add_html_math_renderer()to register a math renderer for HTMLApply :confval:
trim_doctest_flagsto all builders (cf. text, manpages)#5140: linkcheck: Add better Accept header to HTTP client
#4614: sphinx-build: Add
--keep-goingoption to show all warningsAdd :rst:role:
math:numrefrole to refer equations (Same as :rst:role:eq)quickstart: epub builder is enabled by default
#5246: Add :confval:
singlehtml_sidebarsto configure sidebars for singlehtmlbuilder
#5273: doctest: Skip doctest conditionally
#5306: autodoc: emit a warning for invalid typehints
#4075, #5215: autodoc: Add :confval:
autodoc_default_optionswhich acceptsoption values as dict
Bugs fixed
1.8.0b2
in partial builds. See also #5337.
pygments_styleof theme was overridden byconf.pyby default
:members:causes:special-members:not to be shown:download:, duplicate names, andparallel builds
1.8.0b1
to Shengjing Zhu.
Features removed
1.8.0b1
sphinx.ext.pngmathextensionDocumentation
1.8.0b1
v1.7.9Compare Source
=====================================
Features added
Bugs fixed
v1.7.8Compare Source
=====================================
Incompatible changes
env.includedhas been changed to dict of setBugs fixed
man_pagesAnytypehint causes formatting errorgenerated files
v1.7.7Compare Source
=====================================
Bugs fixed
builds
console output (refs: #5236)
console output with recent LaTeX (refs: #5237)
1.5
latex_enginedocumentation regarding Latin Modernfont with XeLaTeX/LuaLateX (refs: #5251)
getargspec()raises NameError for invalid typehintsv1.7.6Compare Source
=====================================
Bugs fixed
\sphinxupquote{}breaks in RussianNode.get_marker(name)intersphinx. Thanks to Alan M. Carroll.
sphinx.apidoc:main()has changedsphinx:main()has changedsphinx.cmd.build.main()referssys.argvinstead of givenargument
with literal notation
sorting
None" as a type@,!, or"failsarguments
v1.7.5Compare Source
=====================================
Bugs fixed
module starting with underscore
contents, topic, admonition, table and section.
(escaped) line breaks are present.
desc_addnamenodes for prefixes of names.LaTeX engine crashed
None" as a typemocked module
napoleon module
v1.7.4Compare Source
=====================================
Bugs fixed
v1.7.3Compare Source
=====================================
Bugs fixed
_templates/longtable.tex_tis brokendifferent
latex_show_urlsassigns incorrect footnote numbers ifhyperlinks exists inside substitutions
\sfis not supportedv1.7.2Compare Source
=====================================
Incompatible changes
TOC
Bugs fixed
<div>in viewcode html outputv1.7.1Compare Source
=====================================
Deprecated
sphinx.build_main()is deprecated.sphinx.ext.autosummary.get_documenter()hasbeen changed (Since 1.7.0)
sphinx.ext.intersphinx.debug()is deprecated.For more details, see :ref:
deprecation APIs list <dev-deprecated-apis>.Bugs fixed
appeared at top of the argument list
epub_schemedoes not effect to content.opfsphinx.buildhas been changed in 1.7.0sphinx.ext.autosummary.get_documenter()hasbeen changed
:glob:optionthisin expression parsing.anyrefs withtermtargets crash when an ambiguity isencountered
v1.7.0Compare Source
=====================================
Dependencies
1.7.0b1
packagingpackageIncompatible changes
1.7.0b1
package when
--implicit-namespacesoption given, not subdirectories ofgiven directory.
:confval:
keep_warningsisTrue. They are only emitted to stderr.autodoc_mock_importsonly mocks specified moduleswith their descendants. It does not mock their ancestors. If you want to
mock them, please specify the name of ancestors explicitly.
(refs: #4295)
options
body_min_widthandbody_max_width.exclude_patternsarguments are ignored if they areplaced just after command line options
1.7.0b2
csssblock tocssDeprecated
1.7.0b1
html_sidebarsis deprecated and only listvalues will be accepted at 2.0.
format_annotation()andformatargspec()is deprecated. Please usesphinx.util.inspect.Signatureinstead.sphinx.ext.autodoc.AutodocReporteris replaced bysphinx.util.docutils. switch_source_input()and now deprecated. It will be removed in Sphinx 2.0.sphinx.ext.autodoc.add_documenter()andAutoDirective._registeris nowdeprecated. Please use
app.add_autodocumenter()instead.AutoDirective._special_attrgettersis now deprecated. Please useapp.add_autodoc_attrgetter()instead.Features added
1.7.0b1
C++, handle
decltype(auto).#2406: C++, add proper parsing of expressions, including linking of
identifiers.
C++, add a
cpp:exprrole for inserting inline C++ expressions or types.C++, support explicit member instantiations with shorthand
templateprefixC++, make function parameters linkable, like template params.
#3638: Allow to change a label of reference to equation using
math_eqref_formatNow :confval:
suppress_warningsaccepts following configurations:ref.python(ref: #3866)[#3872](https://redirect.github.com/sph
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 was generated by Mend Renovate. View the repository job log.