Sphinx 3.1

发布 3.1.2 （发布于 2020年7月5日）

不兼容的更改

  • #7650: autodoc: 装饰过的函数将显示基本函数的签名,而不是装饰器的签名

修复的错误

  • #7844: autodoc: 无法在给定相对模块名称时检测模块

  • #7856: autodoc:当非类对象传递给autoclass指令时,抛出AttributeError

  • #7850:autodoc:当autodoc_typehints为’description’时,因无效标记而引发KeyError

  • #7812:autodoc:如果目标名称同时与一个属性和同名模块匹配,则崩溃

  • #7650: autodoc: 如果函数被通用装饰器修饰,函数签名变为 (*args, **kwargs)

  • #7812: autosummary: 如果目标代码包含同名的属性和模块,则会生成损坏的存根文件

  • #7806: viewcode: 无法解析针对第三方构建器的viewcode引用

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

  • #7878: html主题:”overflow”与”float”之间的不良交互

发布 3.1.1（发布于 2020年6月14日）

不兼容的更改

  • #7808: napoleon: 一种属性类型被表示为类型字段

功能新增

  • #7807: autodoc: 当type_comment与其签名不匹配时显示详细警告

修复的错误

  • #7808: autodoc: 变量和属性类型注释时引发的警告

  • #7802:autodoc:在并行构建时引发EOFError

  • #7821: autodoc: 对重载的 C 扩展函数抛出 TypeError

  • #7805:autodoc:一个描述符返回的对象被意外文档化

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

  • #7812: autosummary: 如果目标代码包含同名的属性和模块,则会生成损坏的存根文件

  • #7808: napoleon: 变量和属性类型注解引发的警告

  • #7811: sphinx.util.inspect 引发循环导入问题

Release 3.1.0（发布于2020年6月8日）

依赖关系

  • #7746: mathjax: 更新至 2.7.5

不兼容的更改

  • #7477: imgconverter: 默认在Windows上调用”magick convert”命令

过时

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

  • sphinx.ext.autosummary.generate.AutosummaryRenderer takes an object type as an argument

  • The ignore argument of sphinx.ext.autodoc.Documenter.get_doc()

  • The template_dir argument of sphinx.ext.autosummary.generate. AutosummaryRenderer

  • The module argument of sphinx.ext.autosummary.generate. find_autosummary_in_docstring()

  • The builder argument of sphinx.ext.autosummary.generate. generate_autosummary_docs()

  • The template_dir argument of sphinx.ext.autosummary.generate. generate_autosummary_docs()

  • The ignore argument of sphinx.util.docstring.prepare_docstring()

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

  • sphinx.util.rpartition()

功能新增

  • LaTeX: 在 LaTeX 主题中使 toplevel_sectioning 设置变为可选

  • LaTeX:允许从LaTeX主题覆盖纸张大小和字号

  • LaTeX: 添加 latex_theme_options 以覆盖主题选项

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

  • C,添加了作用域控制指令,:rst:dir:c:namespace ,:rst:dir:c:namespace-push 和 c:namespace-pop .

  • #2044: autodoc: 抑制实例属性的默认值

  • #7473: autodoc: 如果文档字符串在信息字段列表中包含 :meta public: ,则将成员视为公有

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

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

  • #7384:autodoc:支持由 __new__() 定义的签名、metaclass 和内置基类

  • #2106: autodoc: 支持在文档字符串中使用多个签名

  • #4422: autodoc: 支持 Python 3.7 或更高版本中的 GenericAlias

  • #3610: autodoc: 支持重载函数

  • #7722: autodoc: 支持 TypeVar

  • #7466: autosummary: 生成文档中的标题未翻译

  • #7490: autosummary: 为autosummary指令添加 :caption: 选项,以设置toctree的标题

  • #7469: autosummary: 支持模块属性

  • #248, #6040: autosummary: 为 autosummary 指令添加 :recursive: 选项以递归生成存根文件

  • #4030: autosummary: 添加 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 主题:规范网址没有被转义

  • #7533: html主题: 避免在genindex.html开头出现空格

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

  • #7542:HTML 主题:使警告框/主题/侧边栏可滚动

  • #7543: html 主题:为表格添加上下边距

  • #7695: html 主题: 为基础主题添加 viewport 元标签

  • #7721: html 主题: 经典: 默认的 codetextcolor/codebgcolor 不覆盖 Pygments

  • C 和 C++:允许在声明的末尾使用分号.

  • C++,解析参数化的noexcept说明符.

  • #7294: C++,解析带有用户定义字面量的表达式.

  • C++,解析后置返回类型.

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

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

  • #7770: 标准域: option 指令支持 foo[=bar] 形式的参数

  • #7582: napoleon: 一种表示属性的类型像类型注释

  • #7734: napoleon: 属性上的过度转义尾部下划线

  • #7247: linkcheck: 添加 linkcheck_request_headers 以为特定主机发送自定义 HTTP 头

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

  • #7683: 向 Sphinx.emit() 添加 allowed_exceptions 参数,以允许处理程序抛出指定的异常

  • #7295: C++,解析（尾随）requires子句.

修复的错误

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

  • #7564: autodoc: 不应显示描述符的注释

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

  • #7469: autodoc: 变量的autodoc-process-docstring的更改意外地被缓存

  • #7559:autodoc:错误地将同步函数检测为异步

  • #6857: autodoc: 无法检测到Enum类上的类方法

  • #7562: autodoc: 类型提示包含空格在 :confval:`autodoc_typehints```=’description’``模式下被错误渲染

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

  • #7362: autodoc: 对内置函数未正确渲染签名

  • #7654: autodoc:Optional[Union[foo, bar]] 被表示为 Union[foo, bar, None]

  • #7629: autodoc: autofunction 如果指定了无效对象,则发出不友好的警告

  • #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 对象时出现 ValueError

  • #7791: autodoc: 在文档化单一调度函数时引发 TypeError

  • #7551: autosummary: 嵌套类被索引为非嵌套类

  • #7661: autosummary: autosummary 指令在无法导入目标模块时发出两次警告

  • #7685: autosummary: 模板变量 “members” 包含导入的成员,即使 autossummary_imported_members 设置为 False

  • #7671: autosummary: 导入失败警告的位置缺失

  • #7535: sphinx-autogen: 当自定义模板使用继承时崩溃

  • #7536: sphinx-autogen: 当模板使用国际化(y18n)功能时崩溃

  • #7781: sphinx-build: 当outdir不是目录时错误消息不正确

  • #7653: sphinx-quickstart: 修复嵌套相对路径的多个目录创建

  • #2785: html: 方程链接对齐错误

  • #7718: html 主题: 某些主题不尊重 Pygments 风格的背景颜色（agogo、haiku、nature、pyramid、scrolls、sphinxdoc 和 traditional）

  • #7544: html 主题:警告框内边距不一致

  • #7581: napoleon: 属性文档字符串中的内联代码解析错误

  • #7628: imgconverter: 对于不支持图像的构建器,重复运行 imagemagick

  • #7610: 不正确地渲染连续的反斜杠 适用于 Docutils 0.16

  • #7646: 处理事件处理程序中的错误

  • #4187: LaTeX: EN DASH 在日本文档的PDF书签中消失

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

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

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

  • #7760: 覆盖率: 添加 coverage_show_missing_items 以在控制台显示覆盖率结果

  • C++,修复在全局作用域中显式以嵌套名称开始的渲染和交叉引用,例如 `` ::A::B`` .

  • C,修复在全局范围内显式以嵌套名称渲染和交叉引用,比如 .A.B .

  • #7763: C 和 C++ 在展开一元表达式和折叠表达式的字符串表示时不会崩溃.