Sphinx 1.6

版本1.6.7（发布于2018年2月4日）

Bug 修复

• #1922: html search: 法语中的大写字符问题

• #4412: jQuery 版本从3.1.0更新到3.2.1

• #4438: math: 带空格标签的数学导致 html 错误

• ＃2437：完整引用类，别名为 “ alias of”

• ＃4434：纯数字作为链接目标会产生警告

• #4477: 构建特定文件后构建失败

• ＃4449：apidoc：包括包含模块的“空”软件包

• ＃3917：引文标签转换为省略号

• ＃4501：graphviz：如果图形不可单击导致epub3验证错误

• ＃4514：graphviz：graphviz 生成的错误地图 ID 的解决方法

• ＃4525：autosectionlabel 不支持并行构建

• ＃3953：当有 intersphinx 间库存有效时，不要发出警告

• #4487: math：在并行构建中引发ValueError。 感谢jschueller。

• #2372: autosummary：为类型注释的函数显示了无效的签名

• ＃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 （参考号：＃4142，＃4357）

Bug 修复

• ＃4334：sphinx-apidoc：不要在TOC中生成对不存在文件的引用

• ＃4206：Latex：段落之间的reST标签丢失段落中断

• ＃4231：html：仅在Firefox下应用fixFirefoxAnchorBug

• #4221:napoleon依赖于autodoc，但用户需要手动加载

• #2298:automodule无法记录类属性

• #4099:：C++：从内部构造函数正确链接类引用到类

• #4267:Unicode U+2116数字符号字符破坏了PDF生成

• #4249:PDF输出：Pygments错误突出显示增加代码块中的行距

• #1238:在PDF输出中支持“：强调行：”

• #4279：使用多个进程和远程映像运行时，Sphinx崩溃并出现酸洗错误

• #1421:尊重狮sphinx-quickstart的勿扰标识

• ＃4281：创建输出目录时的竞争条件

• #4315:对于PDF“howto”文档，“latex”顶层“u sectioning=”part“`”生成“chapter”命令

• #4214: Two todolist directives break Sphinx 1.6.5

• 用intersphinx修复外部选项文档的链接（参考：#3769）

• #4091：不带:undoc-members:的私有成员未记入文档

版本1.6.5（2017年10月23日发布）

新增特性

• #4107:制造搜索工具.js与Sphinx1.5之前的模板兼容

• #4112:如果已设置smart_quotes设置，请不要覆盖它

• #4125：在i18n警告信息上显示原文和译文的参考文本

• #4147:在记录采购订单/生产订单文件读/写时包含异常

Bug 修复

• #4085:使用“:align:”选项从解析文本中的图像生成PDF失败

• #4100:从autodoc扩展中删除调试打印

• #3987: Changing theme from alabaster causes HTML build to fail

• 第4096条：C++，在使用错误的角色类型时不要崩溃。多亏了mitya57。

• #4070，#4111:警告消息包含格式字符串时崩溃（再次）

• #4108:搜索词突出显示打断SVG图像

• #3692:如果写入.buildinfo失败，则无法生成HTML

• #4152: HTML writer crashes if a field list is placed on top of the document

• #4063:为 .. todolist:: 指令添加标签时Sphinx崩溃

• #4134： [doc]： docutils.conf 没有明确记录

• #4169:中文不会自动触发中文搜索

• #1020： ext.todo在pdflatex中没有链接到该页

• #3965:新的快速启动在Makefile中生成错误的SPHINXBUILD

• #3739: :module: 选项在pyobjects的内容处被忽略

• #4149:文档：帮助选择 latex_engine

• #4090:[doc] latex_additional_files 包含额外的latex宏不应使用 .tex 扩展名

• 无法将reST解析器错误转换为警告（参考：#4132）

1.6.4版（2017年9月26日发行）

新增特性

• #3926:新增“autodoc_warningiserror”，以禁止在autodoc上导入目标模块时“-W”选项的行为

Bug 修复

• #3924:在扩展中动态分析RST后丢失docname

• #3946:键入sphinx.sty（这是一个在默认上下文中没有效果的bug）

• pep:

  and:rfc:不支持“default role”指令（参考：#3960）

• #3960: default_role = 'guilabel' 未起效

• 缺少要在windows上的latexpdf builder中使用的“texinputs_win/Makefile”。

• #4026:自然：修复macOS Safari滚动条颜色

• #3877：修复了C ++多行签名。

• #4006:修复并行生成时的崩溃

• #3969: 私有实例属性导致AttributeError

• 4041：C++，删除函数指针中的额外名称链接。

• #4038:C，添加缺少的“member”角色文档。

• #4044:空的多列单元格导致PDF输出中出现额外的行高

• #4049:修复sphinx build-h输出中的错误

• #4062个：hashlib.sha1()必须使用字节，而不是Python 3上的unicode

• 避免在Latex中索引项后出现缩进（参考：#4066）

• #4070:警告消息包含格式字符串时崩溃

• #4067:make子流程失败时返回非零退出状态

• #4055: graphviz：：align:选项不适用于SVG输出

• #4055: graphviz：：align:center选项不适用于Latex输出

• #4051: warn() function for HTML theme outputs 'None' string

1.6.3版（2017年7月2日发行）

新增特性

• Latex：提示代码块在下一页继续（参考：#3764，#3792）

Bug 修复

• #3821: Failed to import sphinx.util.compat with Docutils 0.14rc1

• #3829: sphinx-quickstart template is incomplete regarding use of alabaster

• #3772: 'str object' 并未指向 'filename'

• 如果引文标签包含连字符，则发出错误警告（参考：෭3565）

• #3858:使用--color选项时，某些警告未着色

• #3775:删除默认模板中不需要的空白

• #3835个：sphinx.ext.imgmath 如果项目目录名包含空格，则无法转换SVG图像

• #3850:修复make模式的help命令中的颜色处理

• #3865: use of self.env.warn in Sphinx extension fails

• #3824:自Sphinx 1.6.1以来，生产列表应用智能报价转换

• Latex：fix \sphinxfcode 吞没参数的初始空间

• #3878:自动文档化的类属性中的引号应该是PDF输出中的直引号

• #3881: LaTeX 图形浮动到下一页有时会留下额外的垂直空白

• #3885:重复的脚注引发索引错误

• #3873:的弃用警告机制失败 sphinx.util.compat.Directive

• ＃3874：跨文件引用的虚假警告“未引用引用”

• ＃3860：当构建器不支持图像时，不要下载图像

• ＃3860：不支持文件名中断构建器的远程图像URI不支持远程图像

• ＃3833：使用“语言”设置无意翻译了命令行消息。

• ＃3840：严格检查epub_uid

• ＃3851，＃3706：修正了有关PDF输出的方框图字符

• ＃3900：自动摘要找不到方法

• ＃3902：如果latex_documents在py2中包含非Unicode字符串，则发出错误

1.6.2版（2017年5月28日发行）

不兼容的变更

• ＃3789：不需要为Python> = 3.5键入模块

Bug 修复

• ＃3754：如果HTML主题附加了自己的样式表，则HTML生成器崩溃

• ＃3756：epub：未定义实体“ mdash”

• ＃3758：如果在conf.py中发出日志，Sphinx崩溃

• ＃3755：错误地警告您使用literalinclude会降低

• #3742：RTD Sphinx自己的文档的PDF版本缺少书签和目录中的索引条目。 这是`rtfd / readthedocs.org＃2857 <https://github.com/rtfd/readthedocs.org/issues/2857> __问题，使用Sphinx自己的：file：conf文件中的一些额外的LaTeX代码可获得解决方法。 .py

• ＃3770：当“代码块”具有强调行选项并且指示的数字大于行数时，构建失败

• ＃3774：使用引文时，增量HTML构建被破坏

• ＃3763：如果设置了epub_cover，则出现epubcheck验证错误

• ＃3779：由于'sys.meta_path'损坏，sphinx.ext.autodoc中出现'ImportError'。 感谢Tatiana Tereshchenko。

• ＃3796：给定非文档节点时，env.resolve_references() 崩溃

• ＃3803：Sphinx因无效的PO文件而崩溃

• ＃3791：长表的PDF“续下页”未国际化

• ＃3788：smartquotes 发出不支持的语言的警告

• ＃3807：make latexpdf 的Latex Makefile仅适用于unixen

• ＃3781：option指令中的双连字符被编译为endashes

• ＃3817：Latex 生成器引发 AttributeError

1.6.1版（2017年5月16日发行）

依赖

1.6b1

• （更新）Latex输出已通过Ubuntu Trusty的texlive软件包进行了测试（2014年2月），早期的tex安装可能不完全兼容，尤其是关于Unicode引擎xelatex和lualatex

• （补充）在GNU / Linux和Mac OS X上，make latexpdf 是必需的latexmk（参考：＃3082）

不兼容的变更

1.6b1

• #1061, #2336, #3235：现在默认情况下，自动摘要的生成不包含导入的成员。 感谢Luc Saffre。

• LaTeX的includegraphics 命令不会重载：只有sphinxincludegraphics 拥有自定义代码，可以在图像过大时使图像适合可用宽度。

• sphinx.domains.Index 的子类应覆盖 generate() 方法。 默认实现引发NotImplementedError

• LaTeX将长表放置在水平居中的位置，而短表则向左冲（在表周围没有文本流。）现在，在两种情况下，该位置均默认为居中，它将遵循Docutils 0.13的 :align: 选项（参考：#3415，＃ 3377）

• option 指令还允许选项名称的所有标点符号（参考：＃3366）

• ＃3413：如果使用了 literalinclude 的 :start-after：，则使 :lines: 相对（refs＃3412）

• literalinclude 指令不允许将 :diff: 选项和其他选项组合使用（参考：＃3416）

• LuaLaTeX 引擎使用 XeLaTeX 之类的 “fontspec”。 建议 latex_engine = 'lualatex' 仅在最新的 TeX 安装中使用（参考：#3070，＃3466）

• latex_keep_old_macro_names default value has been changed from True to False. This means that some LaTeX macros for styling are by default defined only with \sphinx.. prefixed names. (refs: #3429)

• LaTeX longtable 的页脚 “续下页”现在未定框（参考：＃3497）

• #3529：“BuildEnvironment.__init__” 的参数已更改

• #3082：将 Latexmk 用于 pdf（和dvi）目标（仅适用于 Unix 平台）

• #3558：如果未引用脚注和引用，则发出警告。 警告可以通过 “suppress_warnings” 来禁止。

• Latex 从 pdftex 引擎分发的文件中为 Plain TeX 提供（未记录的）颜色宏。 为了更好地支持多个TeX引擎，将其删除。 Sphinx Latex 编写器的扩展仅应使用 “color”或 “xcolor”包中的接口。（参考：#3550）

• “Builder.env” 在安装中未填写

• #3594：LaTeX：单个原始指令已被视为块级元素

• #3639：如果 “html_experimental_html5_writer” 可用，则 epub 生成器默认使用它。

• 复制 “Sphinx.add_source_parser()” 会引发错误

1.6b2

• #3345：用 Docutils 的 smart_quotes 替换自定义 smartypant 代码。 感谢 Dmitry Shachnev 和 Docutils 的 GünterMilde。

1.6b3

• Sphinx 不再使用也不装载 LaTeX 软件包 “eqparbox”

• Sphinx 不再使用也不加载 LaTeX 包 “multirow”

• 在标准域中向引用数据添加行号

1.6 final

• Sphinx 不再使用也不加载 LaTeX 软件包 “threeparttable” (参考#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” 节点

• defindex.html 模板

• 在 today today_fmt 和 html_last_updated_fmt 中支持LDML格式

• sphinx.ext.graphviz 扩展指令的选项 :inline:

• sphinx.ext.pngmath 扩展

• “sphinx.util.compat.make_admonition()”

新增特性

1.6b1

• #3136：在sphinx.ext.graphviz中的指令中新增：name：选项

• #2336：在 sphinx-autoge n命令中新增 imported_members 选项，以记录导入的成员。

• C ++，在模板化声明中添加：tparam-line-spec：选项。 指定后，每个模板参数将在单独的行上呈现。

• #3359：允许用户区域设置目录中的 sphinx.js 覆盖 Sphinx 中的 sphinx.js

• #3303：在 doctest 指令中添加 :pyversion: 选项。

• #3378: （Latex）支持表指令的 :widths: 选项（参考：＃3379，＃3381）

• #3402：允许使用 suppress_warnings 禁止“下载文件不可读”警告。

• #3377：Latex：新增：为表添加 Docutils 0.13 :align: 选项的支持（但不实现表周围的文本流）。

• Latex：表格内部的脚注已超链接（标题或标题除外）（参考：＃3422）

• 如果在 literalinclude 指令中检测到过度下垂，则发出警告（参考：＃3416）

• 对于 LuaLaTeX 使用与 XeLaTeX 相同的默认设置（即 fontspec 和 polyglossia ）。 （参考：＃3070，＃3466）

• 将 latex_elements 的 'extraclassoptions' 键公开（参考：＃3480）

• ＃3463：为必需的EPUB3元数据新增警告消息。 将默认值新增到 epub_description 以避免类似其他设置的警告。

• #3476：setuptools：支持多个生成器

• Latex：与普通单元格一样，LaTeX 表中的合并单元格允许代码块，列表，块引号... (参考: #3435)

• HTML builder uses experimental HTML5 writer if html_experimental_html5_writer is True and Docutils 0.13 or later is installed.

• LaTeX宏可自定义PDF输出中表格前后的空间（参考号＃3504）

• ＃3348：在literalinclude和viewcode指令中显示装饰器

• ＃3108：如果：start-at：和其他literalinclude选项与文本不匹配，则显示警告

• ＃3609：允许使用“ suppress_warnings”禁止“重复引用”警告

• ＃2803：按入口点发现构建器

• ＃1764，＃1676：允许为样式表设置'rel'和'title'属性

• ＃3589：在非HTML构建器上支持远程图像

• ＃3589：在非HTML构建器上的Data URI中支持图像

• ＃2961：改进 autodoc_mock_imports。现在config值只需要声明应该被模拟的顶级模块。 感谢Robin Jarry。

• ＃3449：在py3上，autodoc使用inspect.signature进行更准确的签名计算。 感谢Nathaniel J. Smith。

• ＃3641：Epub主题支持HTML5编写器生成的HTML结构。

• #3644: autodoc uses inspect instead of checking types. Thanks to Jeroen Demeyer.

• 新增新的扩展名； sphinx.ext.imgconverter。 它将文档中的图像转换为适合构建者的格式

• Latex：使用模板来呈现表格（参考：#3389, 2a37b0e）

1.6b2

• $ BUILDDIR / latex中Makefile的LATEXMKOPTS变量在执行make makexpdf时将选项传递给latexmk（refs＃3695，＃3720）

• Add a new event env-check-consistency to check consistency to extensions

• Add Domain.check_consistency() to check consistency

Bug 修复

1.6b1

• “literalinclude” 指令在 dedent-ing 后展开标签（参考：#3416）

• ＃1574：表格单元格中的段落在Latex输出中不起作用

• ＃3288：带有合并标题的表未包装文本

• ＃3491：PDF中的表和长表周围的垂直空间不一致

• ＃3506：HTML编写器中所有警告的离开函数现在可以正确地将node传递给depart_admonition。

• ＃2693：SphinxLatex样式文件错误地禁止了Latex + dvi（ps，pdf，pdfmx）部分标题的颜色

• C ++，正确查找“ any”引用。

• ＃3624：sphinx.ext.intersphinx无法加载使用gzip压缩的清单

• ＃3551：PDF信息字典缺少作者和标题数据

• ＃3351：intersphinx不引用诸如py：module，py：class之类的上下文。

• 如果父模板已归档，则无法加载模板文件

1.6b2

• ＃3661：sphinx-build在并行构建时崩溃

• ＃3669：gettext生成器失败，并显示“ ValueError：未找到子字符串”

• ＃3660：Sphinx始终依赖于sphinxcontrib-websupport及其依赖项

• ＃3472：Latex中的智能报价错误（至少通过自动属性列出字符串）（参考：＃3345，＃3666）

1.6b3

• #3588: No compact (p tag) html output in the i18n document build even when html_compact_lists is True.

• 由于LaTeX错误，与1.6系列相比，1.6b1版本的 make latexpdf （对于GNU / Linux和Mac OS，使用 latexmk ）中止的时间要早于1.5系列，因为 --halt-on-error 选项（参考#3695）

• ＃3683：默认情况下不提供sphinx.websupport模块

• ＃3683：如果调用 builder.css_file.insert()，则无法生成文档

• ＃3714：视图代码扩展未在帐户中使用 highlight_code ='none'

• ＃3698：将：doc：移至标准域打破了向后兼容性

• ＃3633：误检测未引用的引用

1.6 final

• LaTeX表不允许在标题单元格中包含多个段落

• 从1.6b3开始，LATEXOPTS未正确传递到pdflatex

• ＃3532：短表单元格中的图形或文字块标题导致PDF输出严重破坏

• Fix: in PDF captions of tables are rendered differently whether table is of longtable class or not (refs #3686)

• #3725: Todo looks different from note in LaTeX output

• #3479: stub-columns have no effect in LaTeX output

• #3738：theming.py 中的荒谬代码

• ＃3746：由于未定义的选项 -pdfxe 和 -pdflua，PDF 构建无法使用 Latexmk 4.48或更早版本

已弃用

1.6b1

• 当前不推荐使用 “sphinx.util.compat.Directive”。请使用 “docutils.parsers.rst.Directive”。

• 当前不推荐使用 “sphinx.util.compat.docutils_version”

• 不推荐使用 “Sphinx.warn()” 和 “Sphinx.info()”，请使用 “sphinx.util.logging”（日志接口）。

• #3318：notice 现在已不建议用作LaTeX环境名称，并将在Sphinx 1.7中删除。 扩展作者请改用 sphinxadmonition （与 Sphinx 1.5 起的变动保持一致。）

• 不推荐使用 Sphinx.status_iterator() 和 Sphinx.old_status_iterator()，请使用 sphinx.util:status_iterator()。

• Sphinx._directive_helper() is deprecated. Please use sphinx.util.docutils.directive_helper() instead.

• 不推荐 “BuildEnvironment.set_warnfunc()”

• 以下 “BuildEnvironment” 方法不推荐

  • BuildEnvironment.note_toctree()

  • BuildEnvironment.get_toc_for()

  • BuildEnvironment.get_toctree_for()

  • BuildEnvironment.create_index()

  请使用 “sphinx.environment.adapters” 模块

• latex package footnote is not loaded anymore by its bundled replacement footnotehyper-sphinx. The redefined macros keep the same names as in the original package.

• #3429: deprecate config setting latex_keep_old_macro_names. It will be removed at 1.7, and already its default value has changed from True to False.

• #3221：不推荐使用 epub2 生成器

• #3254: sphinx.websupport is now separated into independent package; sphinxcontrib-websupport. sphinx.websupport will be removed in Sphinx 2.0.

• 不推荐使用 “sphinx_themes”，请使用 “sphinx.html_themes”。

1.6b2

• #3662：不推荐使用 “builder.css_files”，请使用 “add_stylesheet()”。

1.6 final

• LaTeX 的 \sphinxstylethead 在1.6中已弃用，在1.7中将被删除。请将定制移到新的宏 \sphinxstyletheadfamily 中。

测试

1.6 final

• #3458：新增 sphinx.testing （实验中）

版本1.6（未发布）

• 未发布（由于软件包脚本错误）

Previous

Sphinx 1.7

Next

Sphinx 1.5