Sphinx4.4¶

版本4.4.0（2022年1月17日发布）¶

依赖关系¶

#10007：使用 importlib_metadata 适用于Python-3.9或更高版本
#10007：掉落 setuptools

功能添加¶

#9075：autodoc：添加配置变量 autodoc_typehints_format 隐藏函数签名的类型提示的主要模块名称（例如。 io.StringIO -> StringIO )
#9831：自动摘要现在仅记录模块中指定的成员 __all__ 属性if autosummary_ignore_module_all 设置为 False .默认行为不变。Autogen现在还通过 --respect-module-all 开关.
#9555：自动摘要：改善加载目标对象失败时的错误消息
#9800：extlinks：如果硬编码链接可被extlink替换，则发出警告，建议进行替换。
#9961：html：支持<kbd>其他HTML构建器中的嵌套HTML元素
#10013：html：允许通过更改JS的加载方法 loading_method 参数 Sphinx.add_js_file()
#9551：html搜索：“隐藏搜索匹配”链接从URL中删除“突出显示”参数
#9815：html主题：将侧边栏组件包裹在迪夫中，以便通过CSS自定义其布局
#9827：i18 n：按翻译的术语对术语表中的项目进行排序
#9899：py域：允许指定交叉引用说明符 (. 和 ~ ）作为 :type: 选项
#9894：linkcheck：添加选项 linkcheck_exclude_documents 禁用匹配文档中的链接检查。
#9793：phinx-Build：允许在macOS和Python3.8+上使用macOS中的并行构建功能
#10055：phinx-Build：在何时创建目录 -w 给出的选项
#9993：std域：允许引用内联目标（例如。 _`target name '）通过 ref 作用
#9981：std域：从一般索引中删除选项指令的值部分
#9391：texinfo：改进变量 samp 作用
#9578：texinfo：添加 texinfo_cross_references 禁用交叉引用以提高独立阅读器的可读性
#9822、#9062：添加新的Interphinx角色 external 用于在外部项目中进行显式查找，而无需解析到本地项目。

错误已修复¶

#9866：autodoc：导入类的doccomment被忽略
#9883：autodoc：被模仿对象别名的doccomment被忽略
#9908：autodoc：调试消息显示在使用NewTypes和Python 3.10的构建文档上
#9968：autodoc：如果出现以下情况，则不会显示实例变量 __init__ 方法具有仅位置参数
#9194：autodoc：“typing”模块下的类型没有超链接
#10009：autodoc：如果目标对象在获取文档字符串时引发错误，则崩溃
#10058：autosummary：导入的成员不显示时， autodoc_class_signature = 'separated'
#9947：i18 n：具有项目符号列表的主题指令无法翻译
#9878：mathspel：MathJax配置在加载MathJax本身后放置
#9932：napathon：即使没有描述，也会生成空的“返回”部分
#9857：生成的MFC链接使用过时的基本网址
#9909：HTML，防止文本中的行绕法。
#10061：html主题：主题添加的配置值无法从conf.py覆盖
#10073：imgconverter：对“数据”uri调用不必要的可用性检查
#9925：LaTeX：也禁止与 'xelatex' 以内联和解析文字的破折号拆分行
#9944：LaTeX：一些嵌套声明的额外垂直空白
#9940：LaTeX：Python域中的多功能声明在latexpdf输出中的垂直间距狭窄
#10015：py域：“typing”模块下的类型没有在info-field-list中定义的超链接
#9390：texinfo：请勿在脚注内发出标签
#9413：xml：交叉引用python对象时生成无效XML
#9979：错误级别消息显示为警告消息
#10057：如果项目放置在根目录中，则无法扫描文档
#9636：代码块： :dedent: 毫无争议地删除了新线条