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 requests/X.Y.Z python/X.Y.Z"。可以通过 user_agent 进行更改。

  • #6867: text: 提示语内容在空行之后开始

已弃用

  • 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++，支持位域。

  • #267: html: 消除 doctest 块的可复制文本中的提示字符

  • #6548: html: 如果可用，使用 favicon 用于 OpenSearch

  • #6729: html 主题: agogo 主题现在支持 rightsidebar 选项

  • #6780: 添加 PEP-561 支持

  • #6762: latex: 允许通过 latex_elements 的 extrapackages 键加载额外的 LaTeX 包

  • #1331: 添加新的配置变量: user_agent

  • #6000: LaTeX: 允许反斜杠也作为行内文字换行符

  • #4186: LaTeX: 支持 upLaTeX 作为新的 latex_engine (实验性)

  • #6812: 改进扩展不并行安全时的警告信息

  • #6818: 提高 Intersphinx 处理多个远程清单的性能。

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

  • #6798: autosummary: 在生成 stub 文件时发出 autodoc-skip-member 事件

  • #6483: i18n: 使 toctree 中的显式标题可翻译

  • #6816: linkcheck: 添加 linkcheck_auth 选项，以在执行 linkcheck 构建时提供身份验证信息

  • #6872: linkcheck: 处理 HTTP 308 永久重定向

  • #6613: html: 将节号包裹在 span 标签中

  • #6781: gettext: 添加 gettext_last_translator 和 gettext_language_team 以自定义 POT 文件的头部

修复的 Bug

  • #6668: LaTeX: 头部之前的长表格距离不正确 (参考: latex3/latex2e#173)

  • #6618: LaTeX: 避免页面末尾出现节名称

  • #6738: LaTeX: 在支持 Unicode 的 LaTeX 引擎上，不将 Unicode 字符替换为 LaTeX 宏: ¶, §, €, ∞, ±, →, ‣, –, 上标和下标数字“原样”通过（因为默认的 OpenType 字体支持它们）

  • #6704: linkcheck: 采取防御性措施，处理新定义的 HTTP 错误代码

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

  • #6655: 包含 data: 的图像 URL 导致 gettext 构建器崩溃

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

  • #6718: i18n: 如果节标题和表格标题相同，则抛出 KeyError

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

  • #6708: mathbase: 某些已弃用的函数已移除

  • #6709: autodoc: mock 对象不能作为类装饰器使用

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

  • #6712: 允许不将 sphinx.testing 作为运行时安装（主要针对 ALT Linux）

  • #6741: html: 搜索结果在 html_file_suffix 为空时损坏

  • #6001: LaTeX 不会在反斜杠字符处换行长代码行

  • #6804: LaTeX: 如果 danger 类型的提示语包含足够长以至于无法在一页中显示的代码块，则 PDF 构建会中断

  • #6809: LaTeX: danger 类型提示语中的代码块很容易溢出页面底部

  • #6793: texinfo: “sidebar”后的代码示例损坏

  • #6813: 在 Windows 上，对包含的文档发出孤立警告。感谢 @drillan

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

  • #6824: HTML 搜索: 如果搜索词在标题中部分匹配，并在同一页面的文本段落中完全匹配，则搜索不包含此匹配。

  • #6848: config.py 不应从 overrides 中弹出扩展

  • #6867: text: 折行时，连字符单词会插入额外的空格

  • #6886: LaTeX: xelatex 将直双引号转换为右卷曲引号 (当 smartquotes 为 False 时显示)

  • #6890: LaTeX: 即使关闭 smartquotes，PDF 输出仍将直引号和连续连字符转换为卷曲引号和破折号

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

  • #6887: Sphinx 在 Docutils 0.16b0 下崩溃

  • #6920: sphinx-build: 控制台消息被错误地高亮显示

  • #6900: sphinx-build: -D 选项不将 0 和 1 视为布尔值