Sphinx4.1¶

版本4.1.2（2021年7月27日发布）¶

不兼容的更改¶

#9435：linkcheck：禁用检查github.com上自动生成的锚（例如。reST/Markdown文档中的锚点）

错误已修复¶

#9489：autodoc：使用自定义类型 typing.NewType 在3.10的HEAD中没有很好地显示
#9490：autodoc：下的一些对象 typing 3.10的HEAD显示不好
#9436，#9471：autodoc：崩溃，如果 autodoc_class_signature = "separated"
#9456：html搜索：html_Copy_source无法控制搜索摘要
#9500：LaTeX：无法在Windows上构建日语文档
#9435：linkcheck：无法在github.com中检查锚点

版本4.1.1（2021年7月15日发布）¶

依赖关系¶

#9434：phinxcontrib-htmlhelp-2.0.0或以上
#9434：phinxcontrib-serializinghtml-1.1.5或以上

错误已修复¶

#9438：html：HTML徽标或Favicon指定为在输出上找不到文件

版本4.1.0（2021年7月12日发布）¶

依赖关系¶

支持金杯2 -3.0

弃用¶

的 app 论点 sphinx.environment.BuildEnvironment 成为必需的
sphinx.application.Sphinx.html_theme
sphinx.ext.autosummary._app
sphinx.util.docstrings.extract_metadata()

功能添加¶

#8107：autodoc：添加 class-doc-from 选项 autoclass 指令来控制特定类的内容，例如 autoclass_content
#8588：autodoc： autodoc_type_aliases 现在支持虚线名称。它允许您为模块名称为类似的类定义别名 foo.bar.BazClass
#9175：autodoc：模块中未记录特殊成员
#9195：autodoc：的参数 typing.Literal 被错误地呈现
#9185：autodoc： autodoc_typehints 允许 'both' 允许typehints包含在签名和描述中的设置
#4257：autodoc：添加 autodoc_class_signature 将类条目和 __init__() 方法
#8061，#9218：autodoc：支持别名类的变量注释
#3014：autodoc：添加 autodoc-process-bases 修改类定义的基本类
#9272：autodoc：更好地渲染默认参数值的enum值
#9384：autodoc： autodoc_typehints='none' 现在擦除变量、属性和属性的类型提示
#3257：自动摘要：支持类的实例属性
#9358：html：添加“标题”角色到toctree项目
#9225：html：将span标签添加到方法/函数的返回类型提示中
#9129：html搜索：当时显示搜索摘要 html_copy_source = False
#9307：html search：防止在搜索字段中进行更正和完成
#9120：html主题：从可复制文本中消除代码块的提示字符
#9176：i18n：如果在下找不到消息目录文件，则发出调试消息 locale_dirs
#9414：LaTeX：将xeCJK VerbAddon添加到中文文档的默认fvset配置
#9016：linkcheck：支持在github.com上检查锚
#9016：linkcheck：添加新事件 linkcheck-process-uri 在检查超链接之前修改uri
#6525：链接检查：添加 linkcheck_allowed_redirects 将重定向到预期URL的超链接标记为“正在工作”
#1874：py域：支持使用联合类型 | 在信息字段列表中
#9268：py域： python_use_unqualified_type_names 支持info-field-list中的类型字段
#9097：优化并行构建
#9131：添加 nitpick_ignore_regex 使用正规表达忽略吹毛求疵的警告
#9174：添加 Sphinx.set_html_assets_policy 告诉扩展在所有页面中包含HTML资产。扩展可以通过以下方式检查此 Sphinx.registry.html_assets_policy
C++，添加支持
- inline 变量，
- consteval 功能，
- constinit 变量，
- char8_t ,
- explicit(<constant expression>) 说明符，
- 文字形式的数字分隔符，以及
- 占位符类型说明符中的约束，又名。形容词语法（例如， Sortable auto &v ).
C，增加对文字中数字分隔符的支持。
#9166：LaTeX：在LaTeX输出中支持容器

错误已修复¶

#8872：autodoc：错误地呈现堆叠的单一调度
#8597：autodoc：仅具有元数据的文档应视为无文档
#9185：autodoc：重载函数和方法的typehints不准确
#9250：autodoc：继承的方法没有doc字符串被错误解析
#9283：autodoc：autocattribe指令未能为没有任何注释的属性生成文档
#9364：autodoc：默认参数值上的单个元素元组错误呈现
#9362：autodoc：处理Tuple的子集时会引发Veritas错误 [()]
#9404：autodoc：通过autoclass指令处理类似于dict的对象（而不是类）时会引发TypHelp
#9317：html：按下左键会在第一页访问下一页
#9381：html：html_favicon和html_log的URL不起作用
#9270：html主题：金字塔主题生成错误的徽标链接
#9217：manpage：由生成的manpage目录的名称 man_make_section_directory 不正确
#9350：manpage：修复samp角色顶部的关键字后字体未重置
#9306：当远程服务器根据HEAD请求关闭连接时，Linkcheck报告链接损坏
#9280：py domain：“exceptions”模块未显示
#9418：py域：没有参数的Callable注释（例如 Callable[[], None]) 将在缺少括号的情况下呈现 (Callable[], None] )
#9319：quickstart：当conf.py已经存在时退出sphinx-quickstart
#9387：html：HTML Builder忽略自定义访问者
九千二百二十四号： :param: 和 :type: 字段不支持包含空白的类型（例如。 Dict[str, str] )
#8945：转换类型化字段时，调用指定的角色而不是创建单个外部参照。对于C和C++，请使用 expr 类型化字段的角色。