Sphinx 2.3

版本2.3.1（发布于2019年12月22日）

Bug 修复

  • ＃6936：sphinx-autogen：引发 AttributeError

2.3.0版（发布于 2019年12月15日）

不兼容的变更

  • ＃6742：literalinclude 指令的 end-before 选项与代码块的第一行不匹配。

  • ＃1331：将默认的 User-Agent 标头更改为“" Sphinx / X.Y.Z请求/X.Y.Z python / X.Y.Z"”。 详情可参考 user_agent

  • #6867：文字：警告内容在空白行后开始

已弃用

  • sphinx.builders.gettext.POHEADER

  • sphinx.io.SphinxStandaloneReader.app

  • sphinx.io.SphinxStandaloneReader.env

  • sphinx.util.texescape.tex_escape_map

  • sphinx.util.texescape.tex_hl_escape_map_new

  • sphinx.writers.latex.LaTeXTranslator.no_contractions

新增特性

  • ＃6707：C ++，支持 bit-fields。

  • ＃267：html：从可复制文本中消除 doctest 块的提示字符

  • ＃6548：html：如果有就使用 favicon 进行 OpenSearch

  • ＃6729：html主题：agogo 主题支持 rightbar 选项

  • #6780：增加 PEP-561 支持

  • ＃6762：latex：允许通过 latex_elements 键加载其他 LaTeX软件包

  • ＃1331：添加新的配置变量：user_agent

  • #6000：LaTeX：反斜杠也可以是内联文字自动换行符

  • ＃4186：LaTeX：支持 upLaTeX 作为新的 latex_engine （实验中）

  • ＃6812：当扩展不是并行安全时，改进警告消息

  • ＃6818：提高多个远程清单的 Intersphinx 性能。

  • #2546：apidoc：支持 .so 文件

  • #6798：autosummary：生成存根文件时省略 autodoc-skip-member 事件

  • ＃6483：i18n：使 toctree 中的显式标题可译

  • ＃6816：linkcheck：添加 linkcheck_auth 选项以在进行 linkcheck 构建时提供身份验证信息

  • ＃6872：linkcheck：处理 HTTP 308 永久重定向

  • ＃6613：html：在span标签中包裹 span 标签

  • #6781: gettext: Add gettext_last_translator and gettext_language_team to customize headers of POT file

Bug 修复

  • ＃6668：LaTeX：标头具有错误距离之前的 Longtable（参考: latex3/latex2e#173）

  • ＃6618：LaTeX：在页面末尾避免出现节名称

  • #6738：LaTeX：在支持 unicode 的 LaTeX 引擎上，不要用 LaTeX 宏替换 unicode 字符：¶，§，€，∞，±，→，‣，–，上标和下标数字按原样（默认 OpenType 字体支持它们）

  • #6704：linkcheck：防御性强，处理新定义的 HTTP 错误代码

  • #6806：linkcheck：解析内容失败

  • #6655：包含 "data:" 的图像 URL 导致 gettext 生成器崩溃

  • #6584：i18n：在印地语上编译消息目录时出错

  • #6718：i18n：如果节标题和表标题相同，则引发 KeyError

  • #6743：i18n：rst_prolog 破坏了翻译

  • #6708：mathbase：移除某些不好的函数

  • #6709：autodoc：模拟对象不能作为类装饰器工作

  • #5070：epub：错误的内部 href 片段链接

  • #6712：允许不安装 sphinx.testing 作为运行时（主要用于 ALT Linux）

  • #6741：html：搜索结果已断开，空 html_file_suffix

  • #6001：LaTeX 不在反斜杠字符处包装长代码行

  • #6804：LaTeX：PDF 构建中断，如果“危险类型”的警告包含足够长的 code-block，无法放在一个页面上

  • #6809：LaTeX：危险类型警告中的 code-block 很容易溢出页面底部

  • #6793：texinfo：代码示例在“侧边栏”后断开

  • #6813：对 Windows 上包含的文档发出孤立警告。多亏了@drillan

  • #6850：修复 smartypants 模块调用 re.sub() 选项错误

  • #6824：HTML search：如果搜索项在标题中部分匹配，而在同一页的文本段落中完全匹配，则搜索不包括此匹配项。

  • #6848：config.py 不应该从重写弹出扩展

  • #6867：text：在折线上的连字符单词中插入额外的空格

  • #6886：LaTeX：Xeletex将直双引号转换为右曲引号（当 smartquotes 为 False 时显示）

  • #6890：LaTeX：即使关闭 smartquotes，PDF 输出也会将直引号和连续连字符转换为大引号和短划线

  • #6876：LaTeX：标题页上多行显示的作者边缘参差不齐

  • #6887: Sphinx crashes with Docutils 0.16b0

  • #6920: sphinx-build: 一个控制台消息被错误地突出显示

  • #6900: sphinx-build: -D 选项并未将 0 和 1 视作布尔值