Sphinx 2.3

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

修复的错误

  • #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: 文本:警告内容在空行后开始

过时

  • 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: 如果可用,使用OpenSearch的favicon

  • #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: 在生成存根文件时发出 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 文件的头部

修复的错误

  • #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: 国际化: 如果章节标题和表格标题相同,则引发 KeyError

  • #6743: 国际化: rst_prolog 影响翻译

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

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

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

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

  • #6741: html: 带有空 html_file_suffix 的搜索结果已损坏

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

  • #6804: LaTeX: 如果危险类型的警告包含代码块且长度足够不适合一页,则 PDF 构建会中断

  • #6809: LaTeX: 在危险类型的告诫中,代码块可能会轻易溢出页面底部

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

  • #6813:在Windows上包含文档时会发出孤儿警告. 感谢@drillan

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

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

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

  • #6867: 文本:在折叠线上插入了额外的空格到带连字符的词中

  • #6886: LaTeX: xelatex 将直引号转换为右大括号（当 smartquotes 为 False 时显示）

  • #6890: LaTeX:即使关闭了智能引号,PDF 输出仍将直引号和连续连字符转换为弯引号和破折号

  • #6876: LaTeX: 标题页上作者的多行显示有毛边

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

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

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