Sphinx3.0¶
版本3.0.4（2020年5月27日发布）¶
错误已修复¶
#7567：autodoc：对于通用类型，参数化类型显示两次
#7637：autodoc：系统定义的TypVars显示在Python 3.9中
#7696：html：出于安全原因将jQuery版本从3.4.1更新为3.5.1
#7611：启用OpenSSL TIP时md5失败
#7626：发布包不包含
CODE_OF_CONDUCT
版本3.0.3（2020年4月26日发布）¶
功能添加¶
C，使用静态、限定符和VLA规范解析数组声明器。
错误已修复¶
#7516：autodoc：crashes if target object raises an error on accessing its attributes
版本3.0.2（2020年4月19日发布）¶
功能添加¶
C，解析属性并添加
c_id_attributes和c_paren_attributes以支持用户定义的属性。
错误已修复¶
#7461：py域：类型注释中的空数组失败，IndexHelp
#7510：py域：仅关键字参数被记录为默认为无
#7418：std域：
term角色无法不敏感地匹配案例#7461：autodoc：类型注释中的空元组未正确显示
#7479：autodoc：Sphinx自3.0.0以来在mocking上的构建速度变慢
C++，修正east-const声明中的间距问题。
#7414：LaTeX：Xindy语言选项不正确
Sphinx在python3.5.1上崩溃，并出现Import错误
版本3.0.1（2020年4月11日发布）¶
不兼容的更改¶
#7418：std域：
term角色变得敏感
错误已修复¶
#7428：py域：对类的引用
None发出吹毛求疵的警告#7445：py域：返回注释
None使用interphinx时，函数中的签名不会转换为超链接#7418：std域：术语表术语的重复警告不区分大小写
#7438：C++，修复了并行构建中合并超载函数的问题。
#7422：autodoc：使用autodoc_mock_imports时失败并出现Value错误
#7435：autodoc：
autodoc_typehints='description'不会抑制类/方法签名中的类型提示#7451：autodoc：当对象返回非字符串对象作为
__doc__构件#7423：向记录器提供非字符串对象时崩溃
#7479：html主题：不要将xmlns属性包含在HTML5文档类型中
#7426：html主题：逸出HTML模板中的一些链接
版本3.0.0（2020年4月6日发布）¶
依赖关系¶
3.0.0b1
LaTeX：放弃对 extractbb 用于将图像包含在日本文件中作为
.xbb文件不需要 dvipdfmx 自TeXLive2015以来（参考文献：#6189）有babel-2.0或以上可用（Unpined）
不兼容的更改¶
3.0.0b1
删除1.8.x中弃用的功能和API
#247：autosummary：stub文件默认情况下会自动覆盖。 看到
autosummary_generate_overwrite改变行为#5923：autodoc：成员
object默认情况下不会记录类:inherited-members:和:special-members:给出了#6830：py域：
metainfo-field-list中的字段变为保留字段。 它们现在不显示在输出文档上#6417：py域：desc_paramterlist的doctree已更改。 参数名称、注释和默认值用内联节点包装
的结构
sphinx.events.EventManager.listeners已经改变由于范围发生变化
productionlist的一些用途token必须修改以包括以前忽略的范围。#6903：Python、reST和标准域的内部数据结构发生了变化。 note_id被添加到对象和模块的索引中。 现在它们包含一对docName和note_id用于交叉引用。
#7276：C++域：删除非预期行为，例如
say_hello_的链接.. cpp:function:: say_hello()#7210：js域：删除非预期行为，例如
parseInt_的链接.. js:function:: parseInt#7229：rst域：删除非预期行为，例如
numref_的链接.. rst:role:: numref#6903：py域：删除非预期行为，例如
say_hello_的链接.. py:function:: say_hello()#7246：py域：删除异常、函数和方法的特殊交叉引用帮助器
C域已被重写，添加了额外的指令和角色。现有的规定现在更加严格，导致新的警告。
属性
sphinx_cpp_tagname在desc_signature_line节点已重命名为sphinx_line_type.#6462：默认情况下，域指令中的双反斜线不再被单个反斜线替换。新的配置值
strip_signature_backslash可供用户重新启用。
3.0.0决赛
#7222：
sphinx.util.inspect.unwrap()被重命名为unwrap_all()
弃用¶
3.0.0b1
desc_signature['first']sphinx.directives.DescDirectivesphinx.domains.std.StandardDomain.add_object()sphinx.domains.python.PyDecoratorMixinsphinx.ext.autodoc.get_documenters()sphinx.ext.autosummary.process_autosummary_toc()sphinx.parsers.Parser.appsphinx.testing.path.Path.text()sphinx.testing.path.Path.bytes()sphinx.util.inspect.getargspec()sphinx.writers.latex.LaTeXWriter.format_docclass()
功能添加¶
3.0.0b1
#247：自动摘要：添加
autosummary_generate_overwrite覆盖旧的树桩文件#5923：autodoc：
:inherited-members:选项采用祖先类的名称，而不是记录继承的类和上级成员#6830：autodoc：如果doc字符串包含，则认为成员是私有的
:meta private:在信息字段列表中#7165：autodoc：支持注释类型（PEP-593）
#2815：autodoc：支持单派调度函数和方法
#7079：autodoc：
autodoc_typehints接受"description"配置. 它将typehints显示为对象描述#7314：apidoc：apidoc
--maxdepth通过包裹文档进行选择#6558：术语表：针对重复的术语表条目发出警告
#3106：域：自动注册索引页面的超链接目标
#6558：std域：针对重复的通用对象发出警告
#6830：py域：添加新事件：
object-description-transform#6895：py域：不要对内置类型发出吹毛求疵的警告
py域：在函数签名中支持Lambda函数
#6417：py域：允许为函数和方法的参数创建样式
#7238，#7239：py域：如果条目已添加为相同的名称，则发出有关描述Python对象的警告
#7341：py域：签名中的类型注释转换为交叉引用
支持事件处理程序的优先级。更多细节请参见
Sphinx.connect()#3077：实施范围界定
productionlist如文件中所示。#1027：支持反斜线继续
productionlist.#7108：配置：允许通过以下方式显示来自www.example.com的错误消息
ConfigError#7032：html：
html_scaled_image_link对于具有以下内容的图像将被禁用no-scaled-link类#7144：添加CSS类，指示每个描述节点的域
#7211：乳胶：使用XeLaTeX时使用巴别符号作为中文文档
#6672：LaTeX：支持LaTeX主题（实验）
#7005：LaTeX：添加LaTeX样式宏
kbd作用#7220：genindex：首先显示“主要”索引条目
#7103：linkcheck：将所有链接写入
output.json#7025：html搜索：可以对单个文档禁用全文搜索
:nosearch:文件范围元数据#7293：html搜索：允许通过覆盖JavaScript拆分器
SearchLanguage.js_splitter_code#7142：html主题：添加主题选项：
pygments_dark_style在黑暗模式下切换代码块的风格C域已被重写，添加例如：
尊重当前范围的交叉引用。
可以记录匿名实体。
每种类型的实体更具体的指令和角色，例如，处理列举者的范围。
新角色
c:expr用于在文本中呈现表达式和类型。
添加
SphinxDirective.get_source_info()和SphinxRole.get_source_info().#7324：phinx-Build：如果发现同一文档具有不同文件扩展名的多个文件，则发出警告
3.0.0决赛
添加
ObjectDescription.transform_content().
错误已修复¶
3.0.0b1
C++，修复了某些涉及函数超载的情况下的交叉引用查找。
#5078：C++，修复指令包含多个声明时的交叉引用查找。
C++，抑制签名中自动生成的交叉引用中直接依赖类型名的警告。
#5637：autodoc：在show-inheritance上对嵌套类名的处理不正确
#7267：autodoc：无效指令选项的错误消息具有错误位置
#7329：autodoc：info-field-list从类描述中的类型提示错误地生成，即使
autoclass_content='class'设置#7331：autodoc：cython-函数不被识别为函数
#5637：继承_图表：嵌套类名称处理不正确
#7139：
code-block:: guess不起作用#7325：html：source_suffix包含点导致错误的源链接
#7357：html：调整JPEG图像大小失败，出现Value错误
#7278：html search：修复使用
html_file_suffix而不是html_link_suffix在搜索结果中#7297：html主题：
bizstyle不支持sidebarwidth#3842：singlehtml：当主文档不在源根目录中时，图像路径损坏
#7179：std域：修复引用Generic对象时抑制空白
#7289：控制台：使用鲜艳的颜色而不是粗体
#1539：C，解析数组类型。
#2377：C，即使在复杂类型中也会解析函数指针。
#7345：phinx-Build：如果输出目录作为文件存在，Sphinx就会崩溃
#7290：phinx-built：处理异常时忽略bDB.BdbQuit
#6240：napspel：属性和方法部分忽略：noindex：选项
3.0.0决赛
#7364：自动摘要：崩溃时
autosummary_generate是False#7370：自动摘要：当给定未知模块时引发UnboundLocal错误
#7367：C++，现在支持替代操作员拼写。
C，现在支持替代操作员拼写。
#7368：C++，表达式中的逗号运算符，模板参数列表中的包扩展，以及某些情况下更全面的错误消息。
C、C++，修复与anon符号相关的崩溃和错误重复警告。
第6477章：先逃！“在交叉引用链接不再可能
#7219：py域：由生成的索引项
py:function指令与一个不同index具有“内置”类型的指令#7301：note_id不允许使用大写字符
#7301：epub：生成重复的note_id
#6564：html：HTML生成器上忽略了表的宽度
#7401：传递的参数不正确
env-get-outdated处理程序#7355：autodoc：cython-functions的签名无法很好地识别
#7222：autodoc：
__wrapped__功能未正确记录#7409：interphinx：设置扩展时会引发Value错误
intersphinx_mapping对config-inited事件#7343：自2.4.0以来，在调试模式下，Sphinx构建速度一直较慢