Sphinx 2.2

发布 2.2.2（发布日期:2019年12月03日）

不兼容的更改

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

修复的错误

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

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

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

发布版本 2.2.1（发布于 2019 年 10 月 26 日）

修复的错误

  • #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()

  • The info and warn arguments of sphinx.ext.autosummary.generate.generate_autosummary_docs()

  • 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: 快速开始: 将 https://docs.python.org/3/ 用作 intersphinx_mapping 的默认设置

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

修复的错误

  • py 域:重复警告未指向源代码的位置

  • #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: 标准领域: option 指令为每个逗号分隔的选项注册一个索引条目

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

  • #6545: doctest 注释自 Sphinx 1.8.0 起未被修剪

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

  • #6620: i18n: 定义列表的分类器在 Docutils 0.15 下未被翻译

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