Sphinx 3.1

版本3.1.2（2020年7月5日发布）

不兼容的更改

  • #7650：autodoc：装饰函数将显示基函数的签名，而不是装饰者的签名

错误已修复

  • #7844：autodoc：当给定相对模块名称时，无法检测模块

  • #7856：autodoc：当非类对象被赋予autoclass指令时，会引发Veritas错误

  • #7850：autodoc：当autodoc_typehits为“描述”时，会因无效标记而引发KeyMessage

  • #7812：autodoc：如果目标名称与同名的属性和模块匹配，则崩溃

  • #7650：autodoc：函数签名成为 (*args, **kwargs) 如果函数被泛型装饰器装饰，

  • #7812：autosummary：如果目标代码包含同名属性和模块，则生成损坏的树桩文件

  • #7806：viewcode：无法解析第三方构建器上的viewcode引用

  • #7838：html主题：列表项有额外的垂直空间

  • #7878：html主题：“溢出”和“float”之间不需要的交互

版本3.1.1（2020年6月14日发布）

不兼容的更改

  • #7808：napathon：属性的类型表示为类型化字段

功能添加

  • #7807：autodoc：当类型_comment与其签名不匹配时显示详细警告

错误已修复

  • #7808：autodoc：在变量和属性类型注释上引发的警告

  • #7802：autodoc：并行构建时引发EOFRight

  • #7821：autodoc：超载的C-ext函数引发TypHelp

  • #7805：autodoc：描述符返回的对象意外记录

  • #7807：autodoc：使用contextmanager的函数显示错误的签名

  • #7812：autosummary：如果目标代码包含同名属性和模块，则生成损坏的树桩文件

  • #7808：napspel：在变量和属性类型注释上引发的napspel

  • #7811：sphinx.util.inspect导致循环导入问题

版本3.1.0（2020年6月8日发布）

依赖关系

  • #7746：mathmatic：更新到2.7.5

不兼容的更改

  • #7477：imgconverter：在Windows上默认情况下重复使用“magick convert”命令

弃用

  • phinx.ext.autosummary.generate.AutosummaryRenderer的第一个参数已更改为Sphinx对象

  • sphinx.ext.autosummary.generate.AutosummaryRenderer 将对象类型作为参数

  • 的 ignore 论点 sphinx.ext.autodoc.Documenter.get_doc()

  • 的 template_dir 论点 sphinx.ext.autosummary.generate. AutosummaryRenderer

  • 的 module 论点 sphinx.ext.autosummary.generate. find_autosummary_in_docstring()

  • 的 builder 论点 sphinx.ext.autosummary.generate. generate_autosummary_docs()

  • 的 template_dir 论点 sphinx.ext.autosummary.generate. generate_autosummary_docs()

  • 的 ignore 论点 sphinx.util.docstring.prepare_docstring()

  • sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()

  • sphinx.util.rpartition()

功能添加

  • LaTeX：制造 toplevel_sectioning LaTeX主题中的可选设置

  • LaTeX：允许从LaTeX主题覆盖纸质大小和尖头大小

  • LaTeX：添加 latex_theme_options 覆盖主题选项

  • #7410：允许使用抑制“检测到循环toctree引用”警告 suppress_warnings

  • C，添加了范围控制指令， c:namespace , c:namespace-push ，而且 c:namespace-pop .

  • #2044：autodoc：禁止实例属性的默认值

  • #7473：autodoc：如果doc字符串包含，则认为成员是公共的 :meta public: 在信息字段列表中

  • #7487：autodoc：允许通过py：autofunction为singledispatch函数生成文档

  • #7143：autodoc：支持最终类和方法

  • #7384：autodoc：支持由以下人员定义的签名 __new__() 、元类和内建基本类

  • #2106：autodoc：支持文档字符串多个签名

  • #4422：autodoc：支持Python 3.7或更高版本的GenericDocs

  • #3610：autodoc：支持超载功能

  • #7722：autodoc：支持TypVar

  • #7466：自动摘要：生成文档中的标题未翻译

  • #7490：自动摘要：添加 :caption: 自动摘要指令的选项，以设置toctree的标题

  • #7469：自动摘要：支持模块属性

  • #248、#6040：自动摘要：添加 :recursive: 自动摘要指令的选项，以循环方式生成树桩文件

  • #4030：自动摘要：添加 autosummary_context 为自定义模板添加模板变量

  • #7530：html：支持嵌套<kbd>元素

  • #7481：html主题：添加右边距到脚注/引文标签

  • #7482、#7717：html主题：带有标题和行号的代码块的CSS间距

  • #7443：html主题：添加新选项 globaltoc_collapse 和 globaltoc_includehidden 控制侧边栏中globaltoc的行为

  • #7484：html主题：避免边栏和其他块之间的冲突

  • #7476：html主题：Relbar面包屑应包含当前页面

  • #7506：html主题：一个规范的URL是不转义

  • #7533：html主题：避免genindex.html开头的空白

  • #7541：html主题：在“body”的末尾添加“clearer”

  • #7542：html主题：使警告/主题/侧边栏可滚动

  • #7543：html主题：向表格添加上下页边距

  • #7695：html主题：为基本主题添加viewport Meta标签

  • #7721：html主题：经典：默认codeextColor/CodebgColor不会覆盖Pygments

  • C和C++：允许在声明的末尾添加后缀。

  • C++，解析参数化的noexcept说明符。

  • #7294：C++，用用户定义的字面量解析表达。

  • C++，解析尾部返回类型。

  • #7143：py域：添加 :final: 选项 py:class , py:exception 和 py:method 指令

  • #7596：py域：将变量的类型注释更改为超链接

  • #7770：std域： option 指令支持论点的形式 foo[=bar]

  • #7582：napathon：属性的类型像类型注释一样表示

  • #7734：napathon：属性上的尾部强调线过高

  • #7247：链接检查：添加 linkcheck_request_headers 为特定主机发送自定义HTTP标头

  • #7792：setuptools：支持 --verbosity 选项

  • #7683：添加 allowed_exceptions 参数以 Sphinx.emit() 允许处理程序引发指定的异常

  • #7295：C++，解析（尾部）需要句子。

错误已修复

  • #6703：autodoc：增量构建不适用于导入的对象

  • #7564：autodoc：不为描述符显示注释

  • #6588：autodoc：装饰的继承方法没有文档

  • #7469：autodoc：变量的autodoc-Process-doc字符串更改意外缓存

  • #7559：autodoc：misdetects a sync function is automatic

  • #6857：autodoc：未能检测到Enum类上的类方法

  • #7562：autodoc：包含空白的typehint被错误地呈现在 autodoc_typehints ='description' 模式

  • #7551：autodoc：导入嵌套类失败

  • #7362：autodoc：不为内置函数呈现正确的签名

  • #7654：autodoc： Optional[Union[foo, bar]] 被呈现为 Union[foo, bar, None]

  • #7629：autodoc：如果指定的对象无效，autofuncan将发出不友好的警告

  • #7650：autodoc：为装饰函数显示未装饰签名

  • #7676：autodoc：autodoc_member_order默认值中的拼写错误

  • #7676：autodoc：错误的值：member-order：选项被悄然忽略

  • #7676：autodoc：member-order=“bysource”不适用于C模块

  • #3673：autodoc：member-order=“bysource”不适用于具有以下功能的模块 __all__

  • #7668：autodoc：错误的retann值被传递到autodoc-process-signature的处理程序

  • #7711：autodoc：处理numpy对象时失败，并出现Value错误

  • #7791：autodoc：记录singledispatch函数时引发TypeError

  • #7551：自动摘要：嵌套类被索引为非嵌套类

  • #7661：autosummary：如果导入目标模块失败，autosummary指令将发出两次警告

  • #7685：autosummary：模板变量“members”包含导入的成员，即使 autossummary_imported_members 是 False

  • #7671：自动摘要：导入失败警告的位置丢失

  • #7535：phinx-autogen：自定义模板使用继承时崩溃

  • #7536：phinx-autogen：当模板使用i18 n功能时崩溃

  • #7781：sphinx-Build：outchar不是目录时错误消息

  • #7653：phinx-quickstart：修复嵌套rel路径的多个目录创建

  • #2785：html：公式链接对齐不良

  • #7718：html主题：某些主题不尊重Pygments风格的背景色（agogo、俳句、自然、金字塔、卷轴、phinxDoc和传统）

  • #7544：html主题：警告中的填充不一致

  • #7581：naperty：属性文档字符串中的内联代码解析不良

  • #7628：imgconverter：对于不支持图像的构建者来说，一旦不必要，运行imagemick

  • #7610：Docutils 0.16的连续反斜杠渲染错误

  • #7646：处理事件处理程序上的错误

  • #4187：LaTeX：EN DASH从日语文档的PDF书签中消失

  • #7701：LaTeX：匿名间接超链接目标导致标签重复

  • #7723：LaTeX：pdflatex当URL包含单引号时崩溃

  • #7756：py域：未显示仅位置参数的默认值

  • #7760：覆盖范围：添加 coverage_show_missing_items 向控制台显示覆盖结果

  • C++，修复在全局范围内显式开始的嵌套名称中的渲染和外部引用，例如， ::A::B .

  • C，修复在全局范围中显式开始的嵌套名称中的渲染和外部参照，例如， .A.B .

  • #7763：C和C++，在显示一元表达式和折叠表达式的字符串化时不会崩溃。