Sphinx2.1¶
版本2.1.2（2019年6月19日发布）¶
错误已修复¶
#6497：自定义词典在语法错误时无法突出显示
#6478、#6488：信息字段列表被错误识别
版本2.1.1（2019年6月10日发布）¶
不兼容的更改¶
#6447：autodoc：停止为未记录的模块变量生成文档
错误已修复¶
#6442：LaTeX：警告
note类型可以通过页面分隔与前一节标题分开#6448：autodoc：在使用autodocumenting class时崩溃
__slots__ = None#6451：autodoc：为“可选导入”的模块生成文档作为变量
#6452：自动摘要：生成属性文档时崩溃
#6455：naplogs：属性的文档字符串未被处理
#6436：napspel：如果变量名称以强调线结尾，则会出现“未知目标名称”错误
#6440：apidoc：模块之间缺少白线
版本2.1.0（2019年6月2日发布）¶
不兼容的更改¶
忽略没有给予文件扩展名的文件名
Builder.build_specific()直接API#6230：如果术语表指令中术语的锚点由非ASC字符组成，则更改
#4550：html：默认使用CSS对中表
#6239：latex：xelatex和xeCJK默认用于中文文档
Sphinx.add_lexer()现在采用Lexer类而不是实例。 在Sphinx 3.x之前仍然支持lexer实例。
弃用¶
sphinx.builders.latex.LaTeXBuilder.apply_transforms()sphinx.builders._epub_base.EpubBuilder.esc()sphinx.directives.Ackssphinx.directives.Authorsphinx.directives.Centeredsphinx.directives.Classsphinx.directives.CodeBlocksphinx.directives.Figuresphinx.directives.HListsphinx.directives.Highlightsphinx.directives.Includesphinx.directives.Indexsphinx.directives.LiteralIncludesphinx.directives.Metasphinx.directives.Onlysphinx.directives.SeeAlsosphinx.directives.TabularColumnssphinx.directives.TocTreesphinx.directives.VersionChangesphinx.domains.python.PyClassmembersphinx.domains.python.PyModulelevelsphinx.domains.std.StandardDomain._resolve_citation_xref()sphinx.domains.std.StandardDomain.note_citations()sphinx.domains.std.StandardDomain.note_citation_refs()sphinx.domains.std.StandardDomain.note_labels()sphinx.environment.NoUrisphinx.ext.apidoc.format_directive()sphinx.ext.apidoc.format_heading()sphinx.ext.apidoc.makename()sphinx.ext.autodoc.importer.MockFindersphinx.ext.autodoc.importer.MockLoadersphinx.ext.autodoc.importer.mock()sphinx.ext.autosummary.autolink_role()sphinx.ext.imgmath.DOC_BODYsphinx.ext.imgmath.DOC_BODY_PREVIEWsphinx.ext.imgmath.DOC_HEADsphinx.transforms.CitationReferencessphinx.transforms.SmartQuotesSkippersphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()sphinx.util.node.find_source_node()sphinx.util.i18n.find_catalog()sphinx.util.i18n.find_catalog_files()sphinx.util.i18n.find_catalog_source_files()
详情见 deprecation APIs list .
功能添加¶
添加助手类
sphinx.transforms.post_transforms.SphinxPostTransform添加助手方法
PythonDomain.note_module()PythonDomain.note_object()SphinxDirective.set_source_info()
#6180：支持
--keep-going与BuildDocsetup命令math指令现在支持:class:选项待办事项：
todo指令现在支持:name:选项通过环境启用覆盖
SPHINXOPTS和SPHINXBUILDMakefile变量（参考文献：#6232、#6303）#6287：autodoc：无法记录作为模块函数输出的绑定实例方法
#6289：autodoc：
autodoc_default_options现在支持imported-members选项#4777：autodoc：支持协同程序
#744：autodoc：支持抽象方法
#6325：autodoc：支持属性 __slots__. 对于口述式 __slots__, autodoc将值视为属性的文档字符串
#6361：autodoc：添加
autodoc_typehints从签名中抑制类型提示#1063：autodoc：
automodule指令现在处理未记录的模块级变量#6212：自动摘要：添加
autosummary_imported_members在自动摘要上显示导入的成员六二七一：
make clean如果建造到”，就会灾难性地崩溃。'#6363：支持
%O%make.mat中的环境变量#4777：py domain：Add
:async:选项py:function指令py domain：添加新选项
py:method指令:abstractmethod::async::classmethod::property::staticmethod:
rst域名：添加
rst:directive:option描述指令选项的指令#6306：html：将标签添加到搜索表单以实现辅助功能
#4390：html：用于签名的一致和语义CSS
#6358：
rawsource性能production节点现在包含完整的产生规则#6373：autosectionLabel：允许抑制警告
覆盖范围：支持新的
coverage_ignore_pyobjects选项#6239：乳胶：支持构建中文文档
错误已修复¶
#6230：如果术语由非ASC字符组成，术语表指令生成了不适当的节点_id
#6213：ifconnect：标题后的内容未显示
术语表指令中的注释术语被错误识别
#6299：rst域：rst：指令指令生成浪费空间
#6379：py域：模块索引（py-modindex.html）具有重复的标题
#6331：man：当docTest遵循标题时，输出无效
#6351：即使被引用，也会显示“超链接目标未被引用”消息
#6165：autodoc：
tab_widthDocutils的设置已被忽略#6347：autodoc：在Python 3.6和3.5上与普通Tuple一起崩溃
#6311：自动摘要：自动摘要表被复杂类型提示混淆
#6350：自动摘要：被具有某种默认值的参数所困惑
生成的Makefiles缺乏最终截止日期（参考文献：#6232）
#6375：extlinks：无法在链接标题中省略尖括号
#6378：linkcheck：发送常用用户代理
#6387：html搜索：无法搜索带有haiku和scrolls主题的文档
#6408：html搜索：修复搜索结果的排名
#6406：返回的年份错误
SOURCE_DATE_EPOCH#6402：图像指令因未知图像格式而崩溃
#6286：C++，允许8和9为十六进制整元文字。
#6305：修复解析器“路径”参数的快速启动中的字符串
LaTeX：警告中的数字产生了错误（参考文献：#6364）