Sphinx4.0

版本4.0.3（2021年7月5日发布）

功能添加

  • C、添加C23关键词 _Decimal32 , _Decimal64 ，而且 _Decimal128 .

  • #9354：C，添加 c_extra_keywords 允许在解析期间使用用户定义的关键字。

  • 恢复删除 sphinx.util:force_decode() 成为5.0期间再次可用的一些第三方扩展

错误已修复

  • #9330：更改域名： versionchanged 与内容是一个列表将导致错误在pdf构建

  • #9313：LaTeX：自4.0起合并单元格的复杂表格被破坏

  • #9305：LaTeX：反斜线可能会导致日本引擎不恰当的全权委托列表pdf构建错误

  • #9354：C，从关键字列表中删除特殊宏名称。另见 c_extra_keywords .

  • #9322：DeliverateDescDomain转换时引发KeyHelp

版本4.0.2（2021年5月20日发布）

依赖关系

  • #9216：支持jinja 2 -3.0

不兼容的更改

  • #9222：将Underscore.js更新到1.13.1

  • #9217：manpage：默认情况下停止在生成manpage上创建节目录（请参阅 man_make_section_directory )

错误已修复

  • #9210：viewcode：如果在并行构建中发现不可导入的模块，则崩溃

  • #9240：如果不支持节点的扩展安装了丢失引用处理程序，则会引发pending_xref_condition的未知节点错误

版本4.0.1（2021年5月11日发布）

错误已修复

  • #9189：autodoc：当从类的属性生成签名时引发ValueLock时崩溃

  • #9188：autosummary：如果列表值设置为autosummary_generate，则会发出警告

  • #8380：html搜索：搜索结果的标签已损坏

  • #9198：i18 n：Babel在运行compile_catalogue时发出错误

  • #9205：py域：：canonical：选项导致“交叉引用的多个目标”警告

  • #9201：网络支持：未定义错误：“css_tag”未定义

版本4.0.0（2021年5月9日发布）

依赖关系

4.0.0b1

  • 放弃Python 3.5支持

  • 放弃Docutils 0.12和0.13支持

  • LaTeX：添加 tex-gyre 字体依赖性

4.0.0b2

  • 支持Docutils 0.17。 请注意，它会更改HTML生成器的输出。某些主题不支持它，您需要更新自定义CSS才能升级它。

不兼容的更改

4.0.0b1

  • #8539：autodoc：info-field-list会在类描述中生成时 autodoc_typehints ='description' 和 autoclass_content ='class' 设置

  • #8898：extlinks：“%s”成为链接标题字符串中必需的关键字

  • 域名：The Index 类成为的子类 abc.ABC 指示必须在具体类中重写的方法

  • #4826：py域：Python对象的结构发生了变化。 添加一个布尔值以指示pPython对象是规范对象

  • #7425：MathJax：MathJax从2更改为3。使用自定义MathJax配置的用户可能必须设置旧的MathJax路径或更新其版本3的配置。看到 sphinx.ext.mathjax .

  • #7784：i18 n：图像alt文本的msgid已更改

  • #5560：那不勒斯： napoleon_use_param 也影响“其他参数”部分

  • #7996：manpage：默认情况下在生成manpage上创建一个节目录（请参阅 man_make_section_directory )

  • #7849：html：更改的默认设置 html_codeblock_linenos_style 到 'inline'

  • #8380：html搜索：搜索结果包装有 <p> 而不是 <div>

  • html主题：将basic/layout.html中documentation_options.js的脚本标签移动到 script_files 可变

  • html主题：将basic/layout.html中的CSS标签移动到 css_files 可变

  • #8915：html主题：发出警告 sphinx_rtd_theme 0.2.4或以上

  • #8508：LaTeX：uplatex成为日本文档的latex_engine的默认设置

  • #5977：py域： :var: , :cvar: 和 :ivar: 字段不会创建交叉引用

  • #4550： align 属性 figure 和 table 节点变成 None 默认情况下， 'default'

  • #8769：LaTeX重构：将sphinx.sty拆分为多个文件，并重命名在中创建的一些辅助文件 latex 构建输出后备库

  • #8937：使用显式标题而不是<no title>

  • #8487：sv-table指令的：file：选项现在将绝对路径识别为源目录的相对路径

4.0.0b2

弃用

  • html_codeblock_linenos_style

  • favicon 和 logo HTML模板变量

  • sphinx.directives.patches.CSVTable

  • sphinx.directives.patches.ListTable

  • sphinx.directives.patches.RSTTable

  • sphinx.ext.autodoc.directive.DocumenterBridge.filename_set

  • sphinx.ext.autodoc.directive.DocumenterBridge.warn()

  • sphinx.registry.SphinxComponentRegistry.get_source_input()

  • sphinx.registry.SphinxComponentRegistry.source_inputs

  • sphinx.transforms.FigureAligner

  • sphinx.util.pycompat.convert_with_2to3()

  • sphinx.util.pycompat.execfile_()

  • sphinx.util.smartypants

  • sphinx.util.typing.DirectiveOption

功能添加

4.0.0b1

  • #8924：autodoc：支持 bound TypVar参数

  • #7383：autodoc：支持属性的类型提示

  • #5603：autodoc：当Python类有两个不同的名称（规范名称和别名）时，允许使用其规范名称引用Python类

  • #8539：autodoc：添加 autodoc_typehints_description_target 控制的行为 autodoc_typehints=description

  • #8841：autodoc： autodoc_docstring_signature 将继续寻找没有反斜线字符的多个签名行

  • #7549：自动摘要：启用 autosummary_generate 默认情况下

  • #8898：extlinks：链接标题字符串中允许%s

  • #4826：py域：添加 :canonical: Python指令的选项来描述定义对象的位置

  • #7199：py域：添加 python_use_unqualified_type_names 如果可以解析，则隐藏Python引用的模块名称（实验性）

  • #7068：py domain：Add py:property 描述属性的指令

  • #7784：i18 n：默认情况下，图像的alt文本是翻译的（不 gettext_additional_targets 设置）

  • #2018：html： html_favicon 和 html_logo 现在接受图像的URL

  • #8070：html搜索：支持搜索2个字符的单词

  • #9036：html主题：允许继承搜索页面

  • #8938：imgconverter：显示命令可用性检查的错误

  • #7830：添加调试日志以检测源和模板的更改

  • #8201：如果toctree包含重复的条目，则发出警告

  • #8326： master_doc 现已更名为 root_doc

  • #8942：C++，添加对C++20飞船操作员的支持， <=> .

  • #7199：一个新节点， sphinx.addnodes.pending_xref_condition 已添加。它可以根据情况选择合适的参考内容。

4.0.0b2

  • #8818：autodoc：超级一流拥有 Any 参数导致nitpithic警告

  • #9095：autodoc：处理损坏的元类时会引发类型错误

  • #9110：autodoc：GenericSYS的元数据在py 37+中未呈现为引用

  • #9098：html：doctests的复制范围保护在Safari中不起作用

  • #9103：LaTeX：imgconverter：即使不需要，转换也会运行

  • #8127：py domain：info-field-list中的省略导致nitpicky警告

  • #9121：py域：当文档上定义了规范对象及其别名对象时，会发出重复警告

  • #9023：有关域描述的更多CSS类，请参阅 Sphinx添加的Doctree节点类 有关详细信息

  • #8195：数学题： mathjax_config 到 mathjax2_config 并添加 mathjax3_config

错误已修复

4.0.0b1

  • #8917：autodoc：如果功能出错，则发出警告 __globals__ 值

  • #8415：autodoc：从其他模块导入的TypVar未解析（Python 3.7或更高版本）

  • #8992：autodoc：无法解析类型。TracebackType类型注释

  • #8905：html： html_add_permalinks=None 和 html_add_permalinks="" 被忽略

  • #8380：html搜索：搜索结果中的段落未识别为 <p>

  • #8915：html主题： sphinx_rtd_theme 不起作用

  • #8342：如果为指令或角色提供了未知域，则发出警告（例如 :unknown:doc: )

  • #7241：LaTeX：没有包装 cpp:enumerator

  • #8711：LaTeX：TeXLive 2019年底时，代码块中的反勾触发latexpdf构建警告（和字体更改）

  • #8253：LaTeX：未定义大小的图像会过度缩放（与以像素明确设置大小的图像相比）（已修复 'pdflatex'/'lualatex' 仅）

  • #8881：LaTeX：PDF中书签面板的深度不足以导航

  • #8874：LaTeX：修复两个小Pygments LaTeXFormatter输出问题忽略Pygments风格

  • #8925：LaTeX：3.5.0 verbatimmaxunderfull 设置不按预期工作

  • #8980：LaTeX：缺少换行符 \pysigline

  • #8995：LaTeX：遗产 \pysiglinewithargsret 无法正确计算可用的水平空间，应使用不规则的右样式

  • #9009：LaTeX：带星号的“release”值导致LaTeX无效

  • #8911：C++：删除中最长的匹配前置符 cpp_index_common_prefix 而不是第一个匹配的。

  • C，当关键字用作参数名称时，正确拒绝函数声明。

  • #8933：viewcode：无法在并行构建时创建反向链接

  • #8960：C和C++，修复了函数参数列表中（成员）函数指针类型的呈现。

  • C++，修复数组声明器、成员（函数）声明器指针以及参数中名称的链接 sizeof... .

  • C，修复数组声明器中名称的链接。

4.0.0b2

  • C，C++，修复 KeyError 当 alias 指令是文件中的第一个C/C++指令，稍后还有另一个C/C++指令。

4.0.0b3

  • #9167：html：无法将CSS文件添加到特定页面