Sphinx1.6¶
版本1.6.7（2018年2月4日发布）¶
错误已修复¶
#1922：html搜索：法语中的大写字母问题
#4412：将jQuery版本从3.1.0更新到3.2.1
#4438：数学：带有空白标签的数学导致html错误
#2437：完整引用类，别名为“alias of”
#4434：纯数字作为链接目标产生警告
#4477：构建特定文件后构建失败
#4449：apidoc：包括包含模块的“空”包
#3917：引文标签转换为省略号
#4501：graphviz：如果图表不可点击，则会导致epub 3验证错误
#4514：graphviz：graphviz生成的错误地图ID的解决办法
#4525：autosectionLabel不支持并行构建
#3953：当存在有效的interphinx库存时，不要发出警告
#4487：数学：并行构建时会引发Value错误。感谢jschueller。
#2372：自动摘要：类型注释函数显示无效签名
#3942：html：表格未与中心对齐
:align: center
版本1.6.6（2018年1月8日发布）¶
功能添加¶
#4181：autodoc：尽可能对字典关键字进行排序
VerbatimHighlightColor是一个新 LaTeX 'sphinxsetup' 钥匙（参考文献：#4285）代码块渲染中涉及的LaTeX宏的更容易定制
如果conf.py引发异常，则显示追溯（参考文献：#4369）
添加
smartquotes通过禁用智能报价conf.py(refs：#3967）添加
smartquotes_action和smartquotes_excludes(refs：#4142、#4357）
错误已修复¶
#4334：phinx-apidoc：不要生成对目录中不存在文件的引用
#4206：乳胶：段落之间的reST标签丢失段落中断
#4231：html：仅在Firefox下应用fixFirefoxAnchorBug
#4221：napathon依赖autodoc，但用户需要手动加载
#2298：automotive无法记录类属性
#4099：C++：将类引用正确地链接到构造函数内部的类
#4267：PDF构建被Unicode U+2116 NUMO SIGN字符破坏
#4249：PDF输出：Pegments错误突出显示会增加代码块中的行间距
#1238：支持
:emphasize-lines:PDF输出#4279：当与多个进程和远程图像一起运行时，Sphinx崩溃并出现picking错误
#1421：尊重Sphinx快速启动中的安静标志
#4281：创建输出目录时的竞争条件
#4315：对于PDF“howto”文档，
latex_toplevel_sectioning='part'生成\chapter命令#4214：两个托多尔主义指令破坏了Sphinx1.6.5
使用interphinx修复外部选项文档的链接（参考文献：#3769）
#4091：未记录的私人成员没有：undoc-members：
版本1.6.5（2017年10月23日发布）¶
功能添加¶
#4107：使searchtools.js与Sphinx1.5之前的模板兼容
#4112：如果已设置smart_quotes设置，请不要重写它
#4125：在i18 n警告消息上显示原文和翻译段落的参考文本
#4147：在记录PO/MO文件读/写时包括例外
错误已修复¶
#4085：使用解析文本中的图像构建PDF失败
:align:选项#4100：从autodoc扩展中删除调试打印
#3987：将主题从
alabaster导致HTML构建失败#4096：C++，使用错误的角色类型时不要崩溃。感谢mitya 57。
#4070、#4111：当警告消息包含格式字符串时崩溃（再次）
#4108：搜索词突出显示会破坏JPEG图像
#3692：如果写入.buildinfo失败，则无法构建HTML
#4152：如果字段列表放在文档顶部，HTML编写器会崩溃
#4063：标记指令时Sphinx崩溃
.. todolist::#4134： [doc]
docutils.conf没有明确记录#4169：中文不会自动触发中文搜索
#1020：ext. todo todolist未链接到pdflatex中的页面
#3965：新的快速启动在Makefile中生成错误的SPHINXBUILD
#3739：
:module:py对象内容处忽略选项#4149：文档：帮助选择
latex_engine#4090： [doc]
latex_additional_files不应使用额外的LaTeX宏.tex延伸未能将reST解析器错误转换为警告（参考文献：#4132）
版本1.6.4（2017年9月26日发布）¶
功能添加¶
#3926：添加
autodoc_warningiserror抑制的行为-W在autodoc上导入目标模块期间的选项
错误已修复¶
#3924：动态解析扩展中的收件箱后文档名丢失
#3946：phinx.sty中的Typo（这是一个在默认上下文中没有影响的错误）
- pep:
和：rfc：不支持
default-role指令（参考文献：#3960）
#3960：默认_role =“guilabel”不起作用
失踪
texinputs_win/Makefile用于Windows上的latexpdf builder。#4026：自然：修复macOS Safari滚动条颜色
#3877：修复C++多行签名。
#4006：修复并行构建时的崩溃
#3969：私有实例属性导致Locale错误
#4041：C++，删除函数指针中额外的名称链接。
#4038：C，添加缺失的文档
member作用#4044：空的多列单元格会导致PDF输出中额外的行高
#4049：修复phinx-Build-h输出中的拼写错误
#4062：hashlib.sha1（）必须接受字节，而不是Python 3上的Unicode
在乳胶中输入索引后避免重新运行（参考文献：#4066）
#4070：当警告消息包含格式字符串时崩溃
#4067：当使子流程失败时返回非零退出状态
#4055：graphviz：：start：选项不适用于VG输出
#4055：graphviz：：start：center选项不适用于乳胶输出
#4051：
warn()HTML主题的函数输出“无”字符串
版本1.6.3（2017年7月2日发布）¶
功能添加¶
乳胶：提示代码块在下一页继续（参考文献：#3764、#3792）
错误已修复¶
#3821：无法导入带有Docutils 0.14rc1的phinx.util.compat
#3829：phinx-quickstart模板关于使用的不完整
alabaster#3772：“字符串对象”没有属性“文件名”
如果引文标签包括连字符，则发出错误警告（参考文献：#3565）
#3858：使用--color选项时，某些警告未着色
#3775：删除默认模板中不需要的空白
#3835：如果项目目录名称包含空白，phinx.ext.imgmath将无法转换JPEG图像
#3850：修复制作模式帮助命令中的颜色处理
#3865：在Sphinx扩展中使用self. dev.warn失败
#3824：自Sphinx 1.6.1以来，生产列表应用智能引号转换
乳胶：修复
\sphinxbfcode吞噬了最初的争论空间#3878：自动记录的类属性中的引号应该是PDF输出中的直引号
#3881：浮动到下一页的LaTeX图形有时会留下额外的垂直空白
#3885：重复的脚注引发Index错误
#3873：的弃用警告机制失败
sphinx.util.compat.Directive#3874：交叉文件引用“未引用”的虚假警告
#3860：当构建器不支持图像时，不要下载图像
#3860：不支持不带文件名中断构建器的远程图像URIs
#3833：命令行消息无意中翻译为
language设置.#3840：进行检查
epub_uid严格#3851，#3706：修复PDF输出的框绘制字符
#3900：自动摘要找不到方法
#3902：如果发生错误，
latex_documentspy 2中包含非Unicode字符串
版本1.6.2（2017年5月28日发布）¶
不兼容的更改¶
#3789：Python不需要输入模块>=3.5
错误已修复¶
#3754：如果HTML主题添加自己的样式表，HTML生成器就会崩溃
#3756：epub：实体“mdash”未定义
#3758：如果在conf.py中发出日志，Sphinx就会崩溃
#3755：用literalselect错误地警告dent
#3742： RTD Sphinx自己的文档的PDF构建在书签和目录中缺少索引条目。这是 rtfd/readthedocs.org#2857 问题是，使用Sphinx自己的一些额外的LaTeX代码获得了解决办法
conf.py#3770：当“code-block”具有选项emphasze-lines并且指示的数字高于行数时，构建失败
#3774：使用引用时增量HTML构建被破坏
#3763：如果设置了epub_cover，则会出现epubcheck验证错误
#3779：由于“sys.Meta_路径”损坏，phinx.ext.autodoc中的“ImportMessage”。感谢塔蒂亚娜·捷列琴科。
#3796：dev.resolve_referries（）当非文档节点给定时崩溃
#3803：Sphinx崩溃，PO文件无效
#3791：长表的PDF“continued on next page”未国际化
#3788：smartquotes为不支持的语言发出警告
#3807：乳胶Makeline
make latexpdf仅适用于unixen#3781：选项指令中的双连字符被编译为后缀
#3817：乳胶生成剂引发AttribeRight
版本1.6.1（2017年5月16日发布）¶
依赖关系¶
1.6b1
（更新）latex输出使用Ubuntu trusty的texlive包（2014年2月）进行测试，早期的tex安装可能不完全兼容，特别是关于Unicode引擎xelatex和lualatex
（添加）需要乳胶漆
make latexpdf在NU/Linux和Mac OS X上（参考文献：#3082）
不兼容的更改¶
1.6b1
#1061、#2336、#3235：现在自动摘要的生成默认不包含导入的成员。感谢吕克·萨弗尔。
胶乳
\includegraphics命令未超载：仅\sphinxincludegraphics如果图像尺寸过大，则具有自定义代码，以使图像适合可用宽度。的子类
sphinx.domains.Index应重写generate()法 默认实现引发NotImplemented错误LaTeX将长桌水平居中放置，短桌子向左刷新（桌子周围没有文本流动。）现在，在这两种情况下，位置默认为中心，并且将遵守Docutils 0.13
:align:选项（参考#3415、#3377）选项指令还允许选项名称的所有标点符号（参考文献：#3366）
#3413：如果
literalinclude的:start-after:使用，使:lines:相对（参考#3412）literalinclude指令不允许以下组合:diff:选项和其他选项（参考文献：#3416）LuaLaTeX引擎使用
fontspec比如XeLaTeX。建议在作为latex_engine = 'lualatex'仅用于最新的TeX安装（参考文献#3070，#3466）latex_keep_old_macro_names默认值已从TruetoFalse. This means that some LaTeX macros for styling are by default defined only with\sphinx..有前置名字。(refs：#3429）LaTeX长表的脚注“在下一页继续”现在未框（参考文献：#3497）
#3529：的论点
BuildEnvironment.__init__改变#3082：将乳胶包用于pdf（和dvi）目标（仅限类Unix平台）
#3558：如果未引用脚注和引文，则发出警告。 警告可以通过以下方式抑制
suppress_warnings.latex提供（未记录）颜色宏从一个文件分发的pdftex引擎为平原TeX。这是为了更好地支持多个TeX引擎而删除的。仅接口来自
color或xcolor软件包应该由Sphinx latex writer的扩展使用。(refs#3550）Builder.env实例化时未填充#3594：LaTeX：单个原始指令已被视为块级元素
#3639：如果
html_experimental_html5_writer可用，epub构建器默认使用它。Sphinx.add_source_parser()如果重复则会引发错误
1.6b2
#3345：用Docutils的smart_quotes替换自定义smartypants代码。感谢德米特里·沙赫涅夫和Docutils的金特·米尔德。
1.6b3
LaTeX包
eqparbox不再被Sphinx使用和加载LaTeX包
multirow不再被Sphinx使用和加载将行号添加到std域中的引用数据
1.6最终
LaTeX包
threeparttableSphinx不再使用也不再加载（参考#3686、#3532、#3377）
功能已删除¶
配置变量
epub3_contributor
epub3_description
epub3_page_progression_direction
html_translator_class
html_use_modindex
latex_font_size
latex_paper_size
latex_preamble
latex_use_modindex
latex_use_parts
termsep节点definex.html模板
LDML格式支持
today,today_fmt和html_last_updated_fmt:inline:phinx.ext.graphviz扩展指令的选项phinx.ext.pngmath扩展
sphinx.util.compat.make_admonition()
功能添加¶
1.6b1
#3136：添加
:name:中指令的选项sphinx.ext.graphviz#2336：添加
imported_members选项sphinx-autogen记录导入成员的命令。C++，add
:tparam-line-spec:模板化声明的选项。指定后，每个模板参数将在单独的行上呈现。#3359：允许用户区域设置目录中的phinx.js覆盖Sphinx中的phinx.js
#3303：添加
:pyversion:doctest指令的选项。#3378：（乳胶）支持
:widths:表指令选项（参考文献：#3379、#3381）#3402：允许使用抑制“下载文件不可读”警告
suppress_warnings.#3377：乳胶：添加对Docutils 0.13的支持
:align:表格选项（但不实现表格周围的文本流）。乳胶：表格内部的脚注是超链接的（标题或标题除外）（参考文献：#3422）
如果检测到过度凹陷，则发出警告
literalinclude指令（参考文献：#3416）LuaLaTeX使用与XeLaTeX相同的默认设置（即
fontspec和polyglossia). (refs：#3070、#3466）使
'extraclassoptions'关键latex_elements公开（参考#3480）#3463：为所需的EPub 3元数据添加警告消息。添加默认值
epub_description以避免像其他设置一样发出警告。#3476：setuptools：支持多个构建器
latex：LaTeX表中的合并单元格允许代码块、列表、块引号.正常细胞也是如此（参考文献：#3435）
HTML构建器使用实验性HTML5编写器，如果
html_experimental_html5_writer是True并已安装Docutils 0.13或更高版本。LaTeX宏来自定义PDF输出中表格前后的空间（参考#3504）
#3348：在literalselect和viewcode指令中显示装饰器
#3108：如果：start-at：和其他文本包含选项与文本不匹配，则显示警告
#3609：允许使用抑制“重复引用”警告
suppress_warnings#2803：通过进入点发现建造者
#1764、#1676：允许设置样式表的“rel”和“title”属性
#3589：支持非HTML构建器上的远程图像
#3589：在非HTML构建器上支持Data URI中的图像
#2961：改进
autodoc_mock_imports.现在配置值只需要声明应该被模仿的顶级模块。感谢罗宾·贾里。#3449：在py 3上，autodoc使用inspect.Signature进行更准确的签名计算。感谢纳撒尼尔·J·史密斯。
#3641：Epub主题支持由HTML5编写器生成的HTML结构。
#3644：autodoc使用检查而不是检查类型。感谢杰伦·德梅尔。
添加新扩展;
sphinx.ext.imgconverter.它将文档中的图像转换为适合构建者的格式乳胶：使用模板渲染表格（参考#3389，2a37 b0 e）
1.6b2
LATEXMKOPTS中Makefile的变量$BUILDDIR/latex将选项传递给latexmk当执行make latexpdf(refs#3695、#3720）添加新事件
env-check-consistency检查扩展的一致性添加
Domain.check_consistency()检查一致性
错误已修复¶
1.6b1
literalinclude指令在去齿后扩展选项卡（参考文献：#3416）#1574：表格单元格中的段落在Latex输出中不起作用
#3288：合并标题的表格未包装文本
#3491：PDF中表和长表周围的垂直空间不一致
#3506：HTML writer中所有警告的离开功能现在正确通过
node到depart_admonition.#2693：Sphinx乳胶样式文件错误地禁止乳胶+dvi部分标题的颜色（ps、pdf、pdfmx）
C++，正确查找
any参考资料。#3624：phinx.ext. interphinx无法加载用gZip压缩的库存
#3551：PDF信息词典缺乏作者和标题数据
#3351：interphinx不引用类似的上下文
py:module,py:class等如果父模板已存档，则无法加载模板文件
1.6b2
#3661：狮身克斯构建在并行构建时崩溃
#3669：gettext builder fails with“ValueError：substring not found”（获取文本生成器失败，出现“ValueError：子字符串未找到”）
#3660：Sphinx始终依赖于phinxcontrib-webSupport及其依赖项
#3472：乳胶中的智能引号出错（至少通过自动属性使用字符串列表）（参考文献：#3345、#3666）
1.6b3
#3588：i18 n文档构建中也没有紧凑（p标签）html输出，即使在
html_compact_lists是True.的
make latexpdf从1.6b1起（对于NU/Linux和Mac OS，使用latexmk）由于硬编码使用，在LaTeX错误的情况下比1.5系列更早地中止--halt-on-error选项（参考#3695）#3683：默认情况下不提供phinx.webSupport模块
#3683：如果调用builder.css_file.insert（），则无法生成文档
#3714：视图代码扩展不采用
highlight_code='none'账户#3698：移动：Doc：到std域破坏了向后兼容性
#3633：错误检测未引用的引文
1.6最终
LaTeX表不允许标题单元格中有多个段落
自1.6b3以来，LATEXOPTS未正确传递到pdflatex
#3532：短表格单元格中的图形或文字块标题会对PDF输出造成严重破坏
修复：在PDF中，无论表是否属于longtable类，表的标题都会以不同的方式呈现（参考文献#3686）
#3725：Todo看起来与LaTeX输出中的注释不同
#3479：双列在LaTeX输出中没有效果
#3738：theming.py中的荒谬代码
#3746：由于未定义选项，PDF构建在乳胶漆4.48或更早版本中失败
-pdfxe和-pdflua
弃用¶
1.6b1
sphinx.util.compat.Directive类现已被弃用。请改用docutils.parsers.rst.Directivesphinx.util.compat.docutils_version现已弃用#2367:
Sphinx.warn(),Sphinx.info()and other logging methods are now deprecated. Please usesphinx.util.logging(日志记录API) instead.#3318：
notice现已废弃为LaTeX环境名称，并将在Sphinx 1.7中删除。扩展作者请使用sphinxadmonition相反（Sphinx从1.5开始就是这样）。Sphinx.status_iterator()和Sphinx.old_status_iterator()现在已被废弃。 请使用sphinx.util:status_iterator()而不是.Sphinx._directive_helper()已经过时了请使用sphinx.util.docutils.directive_helper()而不是.BuildEnvironment.set_warnfunc()现已弃用以下方法
BuildEnvironment现在已被废弃。BuildEnvironment.note_toctree()BuildEnvironment.get_toc_for()BuildEnvironment.get_toctree_for()BuildEnvironment.create_index()
请使用
sphinx.environment.adapters相反，模块。乳胶包装
footnote不再通过其捆绑替换加载footnotehyper-sphinx.重新定义的宏保留与原始包中相同的名称。#3429：不建议配置设置
latex_keep_old_macro_names.它将在1.7时被删除，并且它的默认值已经从True到False.#3221：epub 2构建器已被废弃
#3254：
sphinx.websupport现在被分成独立的包;sphinxcontrib-websupport.sphinx.websupport将在Sphinx 2.0中删除。#3628：
sphinx_themesentry_point已弃用。 请使用sphinx.html_themes而不是.
1.6b2
#3662：
builder.css_files已经过时了 请使用add_stylesheet()API代替。
1.6最终
胶乳
\sphinxstylethead在1.6处已废弃，并将在1.7处删除。请将自定义移至新宏\sphinxstyletheadfamily.
测试¶
1.6最终
#3458：添加
sphinx.testing（实验性）
版本1.6（未发布）¶
未发布（由于包脚本错误）