Sphinx 2.2

版本 2.2.2 (发布于 2019 年 12 月 3 日)

不兼容的变更

  • #6803: 出于 python 安全原因，在 macOS 和 Python3.8+ 上禁用并行模式

修复的 Bug

  • #6776: LaTeX: 2019-10-01 LaTeX 版本发布破坏了 sphinxcyrillic.sty

  • #6815: i18n: 法语、印地语、中文、日语和韩语的翻译消息已损坏

  • #6803: 并行构建在 macOS 和 Python3.8 上导致 AttributeError

版本 2.2.1 (发布于 2019 年 10 月 26 日)

修复的 Bug

  • #6641: LaTeX: 未定义控制序列 \sphinxmaketitle

  • #6710: LaTeX 未为希腊语主语言进行良好配置

  • #6759: 如果路径在不同目录中，html 静态路径和额外路径的验证不再抛出错误

版本 2.2.0 (发布于 2019 年 8 月 19 日)

不兼容的更改

  • apidoc: 模板文件重命名为 .rst_t

  • html: 字段列表将通过网格布局进行样式化

已弃用

  • sphinx.domains.math.MathDomain.add_equation()

  • sphinx.domains.math.MathDomain.get_next_equation_number()

  • sphinx.ext.autosummary.generate.generate_autosummary_docs() 的 info 和 warn 参数

  • sphinx.ext.autosummary.generate._simple_info()

  • sphinx.ext.autosummary.generate._simple_warn()

  • sphinx.ext.todo.merge_info()

  • sphinx.ext.todo.process_todo_nodes()

  • sphinx.ext.todo.process_todos()

  • sphinx.ext.todo.purge_todos()

新增功能

  • #5124: graphviz: :graphviz_dot: 选项重命名为 :layout:

  • #1464: html: 如果 html_static_path 和 html_extra_path 目录在输出目录内，则发出警告

  • #6514: html: 为可访问性目的向搜索输入添加标签

  • #5602: apidoc: 添加 --templatedir 选项

  • #6475: 为 app.add_autodocumenter() 添加 override 参数

  • #6310: imgmath: 让 imgmath_use_preview 也适用于用于图像渲染内联数学的 SVG 格式

  • #6533: LaTeX: 重构 visit_enumerated_list() 以使用 \sphinxsetlistlabels

  • #6628: quickstart: 将 https://docs.pythonlang.cn/3/ 用于 intersphinx_mapping 的默认设置

  • #6419: sphinx-build: 给出重建原因

修复的 Bug

  • py domain: 重复警告不指向源代码位置

  • #6499: html: 即使原始文件已更改，Sphinx 也从不更新 html_logo 的副本

  • #1125: html 主题: 在经典主题和 macOS 上滚动条很难看到

  • #5502: linkcheck: 视 HTTP 503 响应为非错误

  • #6439: 使生成的下载链接可重现

  • #6486: 如果安装了损坏的扩展，则会引发 UnboundLocalError

  • #6567: autodoc: autodoc_inherit_docstrings 对 __init__() 和 __new__() 无效

  • #6574: autodoc: autodoc_member_order 在 'bysource' 顺序时不引用导入顺序

  • #6574: autodoc: 可变参数和关键字参数缺少类型注释

  • #6589: autodoc: autodoc_typehints=’none’ 的格式问题

  • #6605: autodoc: 当目标代码包含自定义方法式对象时崩溃

  • #6498: autosummary: 在 autosummary_generate 设置错误时崩溃

  • #6507: autosummary: 在没有 autosummary_generate 设置时崩溃

  • #6511: LaTeX: 自 Sphinx 1.8.0 以来，LaTeX 中的自动编号列表无法自定义 (refs: #6533)

  • #6531: 添加扩展时加载最后一个环境对象失败

  • #736: 对索引中的无效排序

  • #6527: last_updated 错误地将时区假定为 UTC

  • #5592: std domain: option 指令为每个逗号分隔的选项注册一个索引条目

  • #6549: sphinx-build: 错误消息中的转义字符

  • #6545: 自 Sphinx 1.8.0 以来，doctest 注释未被修剪

  • #6561: glossary: 为非字母数字术语生成错误的超链接

  • #6620: i18n: 使用 Docutils 0.15 时，定义列表的分类器未被翻译

  • #6474: 当给定的指令不是 ObjectDescription 的子类时，DocFieldTransformer 会引发 AttributeError