Sphinx 3.2

发布 3.2.1（于2020年8月14日发布）

新增特性

  • #8095: napoleon: 添加 napoleon_preprocess_types 以启用 numpy 风格文档字符串的类型预处理器

  • #8114: C 和 C++,在参数和限定符之后解析函数属性.

修复的错误

  • #8074: napoleon: 在处理 C-ext 模块时崩溃

  • #8088: napoleon: “行内文字开始字符串未配对结束字符串”警告在Numpy风格参数部分

  • #8084: autodoc: 记录损坏类的属性时引发KeyError

  • #8091:autodoc:在Python 3.5.2上文档说明属性时引发AttributeError

  • #8099: autodoc: 当目标代码使用 TYPE_CHECKING 时引发 NameError

  • C++,修复模板模板参数的解析,修复#7944导致的问题

发布 3.2.0（发布于 2020 年 8 月 8 日）

过时

  • sphinx.ext.autodoc.members_set_option()

  • sphinx.ext.autodoc.merge_special_members_option()

  • sphinx.writers.texinfo.TexinfoWriter.desc

  • C,解析 pre-v3 风格的类型指令和角色,以及选项 c_allow_pre_v3 和 c_warn_on_allowed_pre_v3 .

新增特性

  • #2076: autodoc: 允许在跳过成员函数中重写 exclude-members

  • #8034: autodoc::private-member: 可以接受一个明确的成员名称列表以进行文档记录

  • #2024: autosummary: 添加 autosummary_filename_map 以避免不同大小写的两个对象之间文件名冲突

  • #8011: autosummary: 支持实例属性作为autosummary指令的目标

  • #7849: html: 添加 html_codeblock_linenos_style 以更改代码块行号的样式

  • #7853: C 和 C++,支持参数化的 GNU 风格属性.

  • #7888: napoleon: 添加别名 Warn 和 Raise.

  • #7690: napoleon: 解析类型字符串并尽可能将它们转换为超链接.转换规则可以通过 napoleon_type_aliases 更新

  • #8049: napoleon: 当 napoleon_use_param 为 False 时,为每种参数类型创建超链接

  • C,增加了 c:alias 指令用于插入现有声明的副本.

  • #7745: html: 如果文档名称包含空格,索引损坏

  • #7991: html搜索:允许搜索数字

  • #7902: html主题:添加一个新选项 globaltoc_maxdepth 以控制侧边栏中globaltoc的行为

  • #7840: 国际化: 优化引导时的依赖检查

  • #7768: 国际化: figure_language_filename 支持 docpath 标记

  • #5208: linkcheck: 支持本地链接检查

  • #5090: setuptools: 将链接的详细程度与distutils的 -v 和 -q 选项关联

  • #6698: doctest: 为doctest、testcode和testoutput指令添加 :trim-doctest-flags: 和 :no-trim-doctest-flags: 选项

  • #7052: 将 :noindexentry: 添加到 Python、C、C++ 和 Javascript 域.更新文档以更好地反映此选项与 :noindex: 选项之间的关系.

  • #7899: C,增加解析某些预 v3 样式类型指令和角色的可能性,并尝试将它们转换为等效的 v3 指令/角色.将新选项 c_allow_pre_v3 设置为 True 以启用此功能.通过将 c_warn_on_allowed_pre_v3 设置为 True 可以抑制此功能打印的警告.该功能将立即弃用.

  • #7999: C,添加对命名可变宏参数的支持.

  • #8071: 允许抑制 “自引用的 toctrees” 警告

修复的错误

  • #7886: autodoc: 在模拟泛型类型类时引发 TypeError

  • #7935: autodoc: 当函数的参数默认值为 inspect._empty 时,函数签名未显示

  • #7901: autodoc: 重载函数的类型注释未被解析

  • #904: autodoc: 实例属性导致autofunction指令崩溃

  • #1362: autodoc:private-members 选项对类属性无效

  • #7983: autodoc: 生成器类型注释在py36中错误呈现

  • #8030: autodoc:当给定 :inherited-members: 选项时,未初始化的注解实例变量不会被文档化

  • #8032: autodoc: 父类中定义的实例变量类型提示未在派生类的文档中显示

  • #8041: autodoc: 当派生类具有其他注释实例变量时,超类上的注释实例变量未被文档化

  • #7839: autosummary: 无法处理函数名中的变音符

  • #7865: autosummary: 在发现缩写时无法提取摘要行

  • #7866: autosummary: 当文档字符串包含超链接目标时,未能提取正确的摘要行

  • #7469: autosummary: “模块属性”标题不可翻译

  • #7940: apidoc: 如果模块有子模块,rst文件末尾会生成额外的新行

  • #4258: napoleon: 装饰的特殊方法未显示

  • #7799: napoleon: 参数在numpydoc中未为组合参数转义

  • #7780: napoleon: 当 napoleon_use_param=True 时,numpydoc中的多个参数声明被错误识别

  • #7715: LaTeX:numfig_secnum_depth > 1 导致错误的图形链接

  • #7846: html 主题: 生成了无效的 XML 文件

  • #7894: gettext: 当使用 rst_epilog 时显示错误的源信息

  • #7691: linkcheck: 不使用 HEAD 请求进行检查

  • #4888: i18n: 无法为翻译中的 :ref: 角色添加显式标题

  • #7928: py 域:未能解析属性的类型注释

  • #8008: py 域: 无法解析包含省略号的类型注解

  • #7994: 标准域:option 指令未生成与 2.x 或更早版本兼容的旧 node_id

  • #7968: 国际化:math 指令的内容在翻译时被解释为 reST

  • #7768: i18n: figure_language_filename 的 root 元素不是用户在文档中指定的路径

  • #7993: texinfo: 对于嵌套对象描述,抛出TypeError

  • #7993: texinfo: 显示不支持 desc_signature_line 节点的警告

  • #7869: abbr 角色如果没有解释,将显示上一个 abbr 角色的解释

  • #8048: graphviz: 在构建非HTML文档时复制了graphviz.css

  • C 和 C++,移除了 noindex 指令选项,因为它没有任何作用.

  • #7619: 如果节点有多个ID,则会生成重复的节点ID

  • #2050: 符号部分在索引页面中出现两次

  • #8017: 修复sphinx.addnodes中的循环导入

  • #7986: CSS: 使 “highlight” 选择器更加稳健

  • #7944: C++,解析以依赖限定名称开头的非类型模板参数.

  • C,处理每个枚举器时不要深度复制整个符号表,以免造成混乱.