Sphinx 3.2

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

新增特性

  • #8095：napoleon：将 napoleon_preprocess_types 增加为 numpy 样式的docstrings 启用类型预处理程序

  • #8114：C和C++，在参数和限定符之后解析函数属性。

Bug 修复

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

  • #8088: napoleon：在Numpy样式参数部分发出警告

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

  • #8091：在 python 3.5.2上记录属性时触发 autodoc:AttributeError

  • #8099：在目标代码使用 TYPE_CHECKING 时触发 autodoc:NameError

  • C++, fix parsing of template template parameters, broken by the fix of #7944

3.2.0 版（2020年8月14日发布）

已弃用

  • sphinx.ext.autodoc.members_set_option()

  • sphinx.ext.autodoc.merge_special_members_option()

  • sphinx.writers.texinfo.TexinfoWriter.desc

  • C, parsing of pre-v3 style type directives and roles, along with the options c_allow_pre_v3 and c_warn_on_allowed_pre_v3.

新增特性

  • #2076：autodoc：允许重写 skip-member 功能中的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 and Raise。

  • #7690：napoleon：解析类型字符串，并使其尽可能多地建立超链接。 转换规则详见 napoleon_type_aliases。

  • #8049: napoleon: Create a hyperlink for each the type of parameter when napoleon_use_param is False

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

  • #7745：：html：如果文档名包含空格，则改清单将受到损坏

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

  • #7902: html theme: 给 globaltoc_maxdepth 增加了一个按钮以控制侧边栏中 globaltoc 的表现

  • #7840：i18n：优化 Bootstrap 的依赖项检查

  • #7768: i18n: figure_language_filename 支持 docpath 代金券

  • #5208：Linkcheck：支持本地的链接的检查

  • #5090：setuptools:：链接详情至 distutils'-v 和 -q 选项

  • #6698：doctest：给 doctest、testcode 和 testoutput 指令增加 :trim-doctest-flags: 和 :no-trim-doctest-flags: 选项。

  • #7052：为 Python, C, C++, and Javascript 域增加 :noindexentry: 。更新了文档以更好地反映此选项与“:noindex:”选项之间的关系。

  • #7899: C, add possibility of parsing of some pre-v3 style type directives and roles and try to convert them to equivalent v3 directives/roles. Set the new option c_allow_pre_v3 to True to enable this. The warnings printed from this functionality can be suppressed by setting c_warn_on_allowed_pre_v3 to True. The functionality is immediately deprecated.

  • #7999：C，添加对命名变量宏参数的支持。

  • #8071：允许禁用 "self referenced toctrees" 警告。

Bug 修复

  • #7886：autodoc：在模拟 generic-typed 类时引发 TypeError。

  • #7935：autodoc：如果函数的参数的默认值为 inspect._empty ，则不显示函数签名

  • #7901：autodoc：未解析重载函数的类型批注

  • #904：autodoc：一个实例的属性导致 autofunction 指令崩溃

  • #1362：autodoc：在类属性中 private-members 选项未生效

  • #7983：autodoc：在 py36 中Generator 类注释错误

  • #8030：autodoc：当提供 :inherited-members: 选项时，未初始化的带注释的实例变量未被记录

  • #8032：autodoc：在父类上定义的实例变量的类型提示不会显示在派生类的文档中

  • #8041：autodoc：当派生类具有其他带注释的实例变量时，不会记录超级类上的带注释实例变量

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

  • #7865：autosummary：找到缩写时无法提取摘要行

  • #7866：autosummary：当 docstring 包含超链接目标时，无法提取正确的摘要行

  • #7469：autosummary："Module attributes" header不可翻译

  • #7940：apidoc：如果模块有子模块，则在 rst 文件的末尾生成一个额外的换行符

  • #4258：napoleon：修饰特殊方法未显示

  • #7799：napoleon: numpydoc 中的组合参数未转义

  • #7780: napoleon: multiple parameters declaration in numpydoc was wrongly recognized when napoleon_use_param=True

  • #7715：LaTeX：numfig_secnum_depth > 1 引发了错误的图形链接

  • #7846：html theme：XML-invalid 文件已生成

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

  • #7691：linkcheck：HEAD 请求无法用于检查

  • #4888：i18n：无法为翻译中 :ref: 角色加一个明晰的标题

  • #7928：py domain：无法解析属性的类型注释

  • #8008：py domain：无法解析包含省略号的类型批注

  • #7994：std domain：选项指令无法生成与 2.x 或更早版本兼容的 node_id

  • #7968：i18n：math 指令的内容在翻译中被译作 reST

  • #7768：i18n：root 要素 figure_language_filename 并非一个用户在文档中可以定义的路径

  • #7993：texinfo：为嵌套对象描述引发 TypeError

  • #7993：texinfo：出现了一个不支持 desc_signature_line node 的警告

  • #7869：没有声明的 abbr 角色，将显示前一个 abbr角色的声明

  • #8048：graphviz：在创建 non-HTML 文档时复制 graphviz.css

  • C 和 C++，移除了无效的 noindex

  • #7619：当 node 含有多个 IDs 时会生成重复的 node IDs

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

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

  • #7986：CSS：强化 "highlight" 选择器

  • #7944：C++，分析以依赖限定名开头的非类型模板参数

  • C，在处理计数器时不要使用 deepcopy 否则每次都报错