Sphinx3.4¶

版本3.4.3（2021年1月8日发布）¶

错误已修复¶

#8655：autodoc：如果目标模块包含引发异常的对象，则无法生成文档 hasattr()

版本3.4.2（2021年1月4日发布）¶

错误已修复¶

#8164：autodoc：继承被模仿类的类没有记录
#8602：autodoc：The autodoc-process-docstring 事件意外地发射到非datadescriptor
#8616：autodoc：将非类对象传递给autodClass指令时引发Veritas

版本3.4.1（2020年12月25日发布）¶

错误已修复¶

#8559：autodoc：使用前向引用类型注释时会引发Veritas
#8568：autodoc：检查slot属性时会引发TypHelp
#8567：autodoc：实例属性被错误添加到父类
#8566：autodoc：The autodoc-process-docstring 事件意外发射到别名类
#8583：autodoc：通过不必要的对象比较 __eq__ 方法
#8565：linkcheck：修复链接二元组不可比时PriorityQueue崩溃

版本3.4.0（2020年12月20日发布）¶

不兼容的更改¶

#8105：autodoc：修饰类会显示类构造器的签名，而不是装饰器的签名

弃用¶

的 follow_wrapped 论点 sphinx.util.inspect.signature()
的 no_docstring 论点 sphinx.ext.autodoc.Documenter.add_content()
sphinx.ext.autodoc.Documenter.get_object_members()
sphinx.ext.autodoc.DataDeclarationDocumenter
sphinx.ext.autodoc.GenericAliasDocumenter
sphinx.ext.autodoc.InstanceAttributeDocumenter
sphinx.ext.autodoc.SlotsAttributeDocumenter
sphinx.ext.autodoc.TypeVarDocumenter
sphinx.ext.autodoc.importer._getannotations()
sphinx.ext.autodoc.importer._getmro()
sphinx.pycode.ModuleAnalyzer.parse()
sphinx.util.osutil.movefile()
sphinx.util.requests.is_ssl_error()

功能添加¶

#8119：autodoc：允许确定成员是否未包含在 __all__ 模块的属性应记录或不通过 autodoc-skip-member 事件
#8219：autodoc：当超级类是通用类并且给出了显示继承选项时，不会显示通用类的参数（在Python 3.7或更高版本中）
autodoc：添加 Documenter.config 作为访问配置对象的快捷方式
autodoc：添加 Optional[t] 如果默认值等于，则转到函数和方法的注释 None 已设置。
#8209：autodoc：添加 :no-value: 选项 autoattribute 和 autodata 指令来抑制变量的默认值
#8460：autodoc：支持通过输入定义的自定义类型。NewType
#8285：纳帕：添加 napoleon_attr_annotations 如果文档字符串中指定了任何类型，则自动合并源代码上的类型提示
#8236：nappedoc：支持numpydoc的“接收”部分
#6914：添加新事件 warn-missing-reference 在解析交叉引用失败时自定义警告消息
#6914：当无法解决问题时发出详细警告 :ref: 参考
#6629：linkcheck：builder现在处理速率限制。看到 linkcheck_rate_limit_timeout 有关详细信息

错误已修复¶

#7613：autodoc：autodoc不尊重 __signature__ 班上
#4606：autodoc：对于继承方法，警告位置不正确
#8105：autodoc：如果类被修饰，则类构造器的签名不正确
#8434：autodoc： autodoc_type_aliases 不影响变量和属性
#8443：autodoc：autodata指令无法为基于PEP-526的类型注释变量创建文档
#8443：autodoc：autocattribe指令无法为基于PEP-526的未初始化变量创建文档
#8480：autodoc：autotallity无法创建文档 __slots__ 属性
#8503：autodoc：autotallity无法正确创建GenericHandler的文档作为类属性
#8534：autodoc：autotaste无法为别名类中的注释属性创建文档
#8452：autodoc：当autodoc_typehints设置为“描述”时，autodoc_类型_aliases不起作用
#8541：autodoc：autodoc_ype_aliases不适用于实例属性的类型注释
#8460：autodoc：autodata和autotattract指令不显示TypVars的类型信息
#8493：autodoc：对内置函数的引用在类别名中不起作用
#8522：autodoc： __bool__ 可以调用方法
#8067：autodoc：未显示超类上具有Type_comment的实例变量的类型提示
#8545：autodoc：a __slots__ 即使有文档字符串，属性也没有记录
#741：autodoc：inherited-members不适用于超类上的实例属性
#8477：自动摘要：当模板包含多字节字符时，生成非utf-8 reST文件
#8501：自动摘要：摘要提取拆分“el at.”之后的文本。“出乎意料
#8524：html：在名为“index”的文档上生成了错误的url_root
#8419：html搜索：不加载 language_data.js 在非搜索页面
#8549：i18n： -D gettext_compact=0 不再工作
#8454：graphviz：图形和有向图形指令的布局选项不起作用
#8131：linkcheck：当HEAD请求导致重定向过多时使用GET，以适应HEAD上的无限重定向循环
#8437：制作文件： make clean 空荡荡的建筑物是危险的
#8365：py域： :type: 和 :rtype: 给出错误的模糊类查找警告
#8352：std域：无法解析以括号开头的选项
#8519：LaTeX：防止seealso中间出现页面刹车
#8520：C，修复AliasNode的复制。