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

  • 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: Add a label to search input for accessibility purposes

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

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

  • #6310：imgmath：让 imgmath_use_preview 也可以使 SVG 格式进行图像呈现的内嵌数学

  • #6533：TeX：refactor访问_enumerated_list（）以使用 "sphinxsetlistlabels"

  • #6628：quickstart：使用 https://docs.python.org/3/ 作为 intersphinx_mapping 的默认设置

  • #6419: sphinx-build: give reasons why rebuilt

Bug 修复

  • Py 域：重复警告不指向源代码的位置

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

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

  • #5502：linkcheck：将 http503 响应视为非错误

  • #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 中自定义自动编号列表（参考文献：#6533）

  • #6531：添加扩展时未能加载最后一个环境对象

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

  • #6527: last_updated wrongly assumes timezone as UTC

  • #5592：标准域: option 指令为每个逗号分隔的选项注册一个索引项

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

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

  • #6561：词汇表：为非字母数字术语生成错误的超链接

  • #6620: i18n: classifiers of definition list are not translated with Docutils 0.15

  • #6474："DocFieldTransformer" 在给定指令不是 ObjectDescription 的子类时引发AttributeError