Sphinx3.2¶
版本3.2.1(2020年8月14日发布)¶
功能添加¶
#8095:naptism:添加
napoleon_preprocess_types
为numpy样式的文档字符串启用类型预处理器#8114:C和C++,解析参数和限定符之后的函数属性。
错误已修复¶
#8074:napathon:处理C-ext模块期间崩溃
#8088:napspel:Numpy样式参数部分中的“Inline litial start-strange without end-strange”警告
#8084:autodoc:记录损坏类的属性时会引发KeyHelp
#8091:autodoc:在Python 3.5.2上记录属性时会引发Veritas错误
#8099:autodoc:当目标代码使用时,会引发Name错误
TYPE_CHECKING
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,解析v3之前的风格类型指令和角色,以及选项
c_allow_pre_v3
和c_warn_on_allowed_pre_v3
.
功能添加¶
#2076:autodoc:允许在skip-member函数中覆盖exclude-members
#8034:autodoc:
:private-member:
可以列出要记录的成员姓名的明确列表#2024:自动摘要:添加
autosummary_filename_map
避免两个不同案例的对象之间的文件名冲突#8011:autosummary:支持实例属性作为autosummary指令的目标
#7849:html:添加
html_codeblock_linenos_style
更改代码块的行号样式#7853:C和C++,支持参数化的NU风格属性。
#7888:napathon:添加别名Warn和Raise。
#7690:naperty:解析类型字符串并尽可能使其超链接。 转换规则可以通过以下方式更新
napoleon_type_aliases
#8049:napathon:当出现以下情况时,为每种参数类型创建超链接
napoleon_use_param
是False
C,补充道
c:alias
插入现有声明副本的指令。#7745:html:如果文档名包含空间,则库存被破坏
#7991:html search:允许搜索数字
#7902:html主题:添加新选项
globaltoc_maxdepth
控制侧边栏中globaltoc的行为#7840:i18 n:优化引导程序上的依赖项检查
#7768:i18 n:
figure_language_filename
支持docpath
令牌#5208:linkcheck:本地链接的支持检查
#5090:setuptools:将详细信息链接到distutils的-v和-q选项
#6698:docTest:添加
:trim-doctest-flags:
和:no-trim-doctest-flags:
docTest、testcode和testext指令的选项#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:允许抑制“自引用toctree”警告
错误已修复¶
#7886:autodoc:在模拟Generative类型类时引发TypHelp
#7935:autodoc:当函数的参数具有
inspect._empty
作为其默认值#7901:autodoc:未解析重载函数的类型注释
#904:autodoc:实例属性导致自动功能指令崩溃
#1362:autodoc:
private-members
选项不适用于类属性#7983:autodoc:生成器类型注释在py36中错误呈现
#8030:autodoc:未初始化的注释实例变量在以下情况下不会被记录
:inherited-members:
给出的选项#8032:autodoc:在父类中定义的实例变量的类型提示没有显示在派生类的文档中
#8041:autodoc:当派生类具有其他带注释的实例变量时,不会记录超类上的带注释的实例变量
#7839:autosummary:无法处理函数名称中的标点符号
#7865:自动摘要:找到缩写时提取摘要行失败
#7866:autosummary:当文档字符串包含超链接目标时,无法提取正确的摘要行
#7469:自动摘要:“模块属性”标题不可翻译
#7940:apidoc:如果模块包含子模块,则在rst文件的结尾处生成额外的白线
#4258:Napoleon:未显示装饰的特殊方法
#7799:nappydoc中的组合参数不会逸出参数
#7780:nappydoc中的多个参数声明被错误识别
napoleon_use_param=True
#7715:LaTeX:
numfig_secnum_depth > 1
导致错误的人物链接#7846:html主题:生成了ML无效的文件
#7894:gettext:使用rst_epilog时显示错误的源信息
#7691:linkcheck:HEAD请求不用于检查
#4888:i18 n:未能添加显式标题
:ref:
翻译中的角色#7928:py域:无法解析属性的类型注释
#8008:py域:无法解析包含省略号的类型注释
#7994:std域:选项指令不会生成与2.x或更早版本兼容的旧ode_id
#7968:i18 n:内容
math
指令在翻译上被解释为reST#7768:i18 n:The
root
元件figure_language_filename
不是用户在文档中指定的路径#7993:texinfo:嵌套对象描述会引发TypHelp
#7993:texinfo:显示不支持desc_signature_line节点的警告
#7869:
abbr
没有解释的角色将显示上一个abbr角色的解释#8048:graphviz:graphviz.css在构建非HTML文档时被复制
C和C++,已删除
noindex
指令选项,因为它什么也没做。#7619:如果节点具有多个ID,则生成重复的节点ID
#2050:符号部分在索引页面中出现两次
#8017:修复sphinx中的循环导入.addnodes
#7986:CSS:使“突出显示”选择器更加稳健
#7944:C++,解析以依赖限定名开始的非类型模板参数。
C,不要深度复制整个符号表,并且每次处理计数器时都会弄得一团糟。