Changelog

版本7.3.0(正在开发中)

依赖关系

不兼容的更改

已弃用

• #11693: 支持老式 Makefile 和 make.bat 输出量 sphinx-quickstart ，以及相关的选项 -M ， -m ， --no-use-make-mode ，以及 --use-make-mode 。

• #11285: 直接访问 sphinx.testing.util.SphinxTestApp._status 或 sphinx.testing.util.SphinxTestApp._warning 已弃用。使用公共属性 sphinx.testing.util.SphinxTestApp.status 和 sphinx.testing.util.SphinxTestApp.warning 取而代之的是。作者：Patch by Bénédikt Tran.

• 测试： sphinx.testing.util.strip_escseq() 不推荐使用，而支持 sphinx.util.console.strip_colors() 。作者：Patch by Bénédikt Tran.

新增特征

• 添加公共类型别名 sphinx.util.typing.ExtensionMetadata 。扩展开发人员可以使用它来批注其 setup 功能。克里斯·休厄尔的Patch。

• #12193: 改进 external 未知角色的警告。特别是，如果对象类型被错误使用，建议使用相关的角色名称。克里斯·休厄尔的Patch。

• #12131: 增列 show_warning_types 配置选项。克里斯·休厄尔的Patch。

• #11701: Html搜索：采用新的 <search> 元素。作者：Patch by Bénédikt Tran.

• #11803: AutoDoc：使用覆盖 __repr__() 函数(如果已定义)。作者：张胜宇。

• #11892: 改进了在CPP域中解析交叉引用时的性能。作者声明：Rouslan Korneychuk；

• #11981: 使用以下功能改进签名的呈现 slice 语法，例如， def foo(arg: np.float64[:,:]) -> None: ... 。

• 手册页构建器现在添加了 OSC 8 指向超链接的锚点，使用 groff 设备控制命令。

• #11015: versionadded 措辞更改为 New in [...] 至 Added in [...] 。作者：Patch by Bénédikt Tran.

修复错误

• #11959: 修复当Word同时出现在标题和文档中时的多个术语匹配。威尔·拉钱斯的佩奇。

• #11958: HTMLSearch：修复部分匹配覆盖完整匹配。作者：William Lachance。

• #11944: 在搜索预览中使用锚点。威尔·拉钱斯的佩奇。

• #11668: 在以下情况下引发有用的错误 theme.conf 失踪了。由Vinay Sajip制作的Patch。

• #11622: 确保按键的顺序输入 searchindex.js 是决定论的。作者：Pietro Albini。

• #11617: 写入警告文件时，ANSI控制序列将从输出中剥离 -w 。作者：Patch by Bénédikt Tran.

• #11666: 跳过中的所有隐藏目录 CatalogRepository.pofiles 。作者：Aryaz Eghbali。

• #9686: 当公式出现在标题中时，修复MathJax延迟加载。作者：Patch by Bénédikt Tran.

• #11483: Singlehtml Builder：修复索引不包含任何数学公式时的MathJax延迟加载。作者：Patch by Bénédikt Tran.

• #11697: HTMLSearch：添加‘noindex’元机器人标签。詹姆斯·爱迪生的补丁。

• #11678: 修复一个可能的 ZeroDivisionError 在……里面 sphinx.ext.coverage 。作者：Stephen Finucane。

• #11756: LaTeX：由于缺失，最近的TeXLive生成错误 substitutefont 程序包(如果使用 fontenc 使用 T2A 选项和文档语言不是西里尔文)。作者：Jean-François B.

• #11675: 修复了不支持ANSI控制序列的环境中进度条的呈现。作者：Patch by Bénédikt Tran.

• #11715: 应用 tls_verify 和 tls_cacerts 配置到 ImageDownloader 。作者：Nick Touran。

• #11433: 添加了 linkcheck_allow_unauthorized 配置选项。将此选项设置为 False 要将HTTP 401(未经授权)服务器响应报告为损坏，请执行以下操作。詹姆斯·爱迪生的补丁。

• #11868: 链接检查：添加了DISTINCT timeout 报告状态代码。詹姆斯·爱迪生的补丁。

• #11869: 刷新文档以获取 linkcheck_timeout 布景。詹姆斯·爱迪生的补丁。

• #11874: 为配置默认的30秒值 linkcheck_timeout 。詹姆斯·爱迪生的补丁。

• #11886: 在中打印JJIA2模板路径链 TemplateNotFound 例外情况。作者声明：Patch by Colin MarQuardt。

• #11598: 请勿在EPUB渲染中使用资源的URL中的查询组件。作者：David Runge。

• #11917: 修复了Python3.9中带注释的继承成员的呈现。珍妮特·卡森所著的Patch。

• #11925: 将黑名单列入 sphinxprettysearchresults 扩展；它提供的功能被合并到Sphinx v2.0.0中。詹姆斯·爱迪生的补丁。

• #11353: 支持从Mixin或数据类型继承的枚举类。作者：Patch by Bénédikt Tran.

• #11962: 修复使用时的目标分辨率 :paramtype: 菲尔兹。作者：Patch by Bénédikt Tran.

• #12008: 修复区分大小写的查找 std:label 星际Sphinx清单中的名字。作者：Michael Goerz。

• #11474: 修复文档树缓存在某些情况下导致文件不能重建的问题，例如 numfig 是 True 。作者：Patch by Bénédikt Tran.

• #11278: AutoDoc：修复渲染 functools.singledispatchmethod 结合 @classmethod 。作者：Patch by Bénédikt Tran.

• #11894: 如果使用htmlHelp生成器构建，请不要将校验和添加到css文件。一块接一块。

• #12052: 移除 <script> 和 <style> 来自搜索结果摘要片段内容的标签。詹姆斯·爱迪生的补丁。

• #11578: HTML搜索：在其他结果之后对非主索引项进行排序。布拉德·金的补丁。

• #12147: 中指定多个后缀时，可能会使用错误的文件扩展名 source_suffix 。作者：Sutou Kouhei。

• #10786: 改进在Sphinx执行过程中删除要复制的文件(例如资产)时的错误消息。作者：Patch by Bénédikt Tran.

• #12040: HTML搜索：确保用户搜索查询部分匹配的文档标题包含在搜索结果中。詹姆斯·爱迪生的补丁。

测试

• #11285: pytest.mark.sphinx() 和 sphinx.testing.util.SphinxTestApp 接受 warningiserror ， keep_going 和 verbosity 作为关键字参数。作者：Patch by Bénédikt Tran.

• #11285: sphinx.testing.util.SphinxTestApp status and warning arguments are checked to be io.StringIO objects (the public API incorrectly assumed this without checking it). Patch by Bénédikt Tran.

• Pytest：报告结果 test_run_epubcheck AS skipped 而不是 success 当Java和/或 epubcheck.jar 代码不可用。

• Utils：对测试的HTTp(S)服务器使用未使用的端口号的动态分配。作为副作用，这消除了对测试服务器锁定文件的需要，这意味着剩余的 tests/test-server.lock 可以安全地删除文件。

版本7.2.6(2023年9月13日发布)

修复错误

• #11679: 添加 SPHINX_AUTODOC_RELOAD_MODULES 环境变量，如果设置该变量，则在与AUTODOG配合使用时重新加载模块 TYPE_CHECKING = True 。作者：Matt Wozniski和Adam Turner。

• #11679: 使用 importlib.reload() 要在AutoDoc中重新加载模块，请执行以下操作。作者：Matt Wozniski和Adam Turner。

版本7.2.5(2023年8月30日发布)

修复错误

• #11645: 修复了阻止AutoDoc在使用 if typing.TYPE_CHECKING: 以保护类型检查器所需的循环导入。作者：Matt Wozniski。

• #11634: 修复了子目录中同级文件的继承图相对链接解析。作者：阿尔伯特·施瓦茨。

• #11659: 允许 ?config=... 在……里面 mathjax_path 。

• #11654: AutoDoc：当对象声称是的实例时，失败并显示更具描述性的错误消息 type ，但不是一个类。詹姆斯·布拉萨的补丁。

• 11620：停止排放 source-read 方法读取的文件的事件 include 指令。

• 11620：添加新的 include-read 用于观察和转换包含的文件的内容 include 指令。

• #11627: 恢复对表单版权行的支持 YYYY 什么时候 SOURCE_DATE_EPOCH 已经设置好了。

版本7.2.4(2023年8月28日发布)

修复错误

• #11618: Fix a regression in the MoveModuleTargets transform, introduced in #10478 (#9662).

• #11649: LinkCheck：解决伦敦以西时区的挂起测试以及从UTC到UNIX纪元的不正确转换。作者：Dmitry Shachnev和Adam Turner。

版本7.2.3(2023年8月23日发布)

依赖关系

• #11576: 需要SPHINXCONTRIB-Serializinghtml 1.1.9。

修复错误

• 修复回归 autodoc.Documenter.parse_name() 。

• 修复JSON序列化中的回归。

• #11543: AutoDoc：支持中的仅位置参数 classmethod 方法：当 autodoc_preserve_defaults 是 True 。

• 还原Path对象上的支持字符串方法。这已被弃用，并将在Sphinx 8中删除。 os.fspath() 要转换 Path 对象转换为字符串，或 Path 的方法来处理Path对象。

版本7.2.2(2023年8月17日发布)

修复错误

• 修改 StateMachine.insert_input() 修补程序，用于使用关键字参数调用。

• 固定成员资格测试 (in )，用于 str 资产类别的接口 (_CascadingStyleSheet 和 _JavaScript )，这是几个扩展所依赖的。

• 修复了中的类型错误 SingleFileHTMLBuilder._get_local_toctree ， includehidden 可以作为字符串或布尔值传递。

• 修整 :noindex: 为 PyModule 和 JSModule 。

版本7.2.1(2023年8月17日发布)

修复错误

• 恢复了 str 资产类别的接口 (_CascadingStyleSheet 和 _JavaScript )，这是几个扩展所依赖的。这将在Sphinx 9中删除。

• 已将呼叫恢复到 Builder.add_{css,js}_file() ，这是几个扩展所依赖的。

• 恢复内网接口 TocTree.get_toctree_ancestors() ，这是几个扩展所依赖的。

版本7.2.0(2023年8月17日发布)

依赖关系

• #11511: 放弃对Python3.8的支持。

• #11576: 需要Pygments 2.14或更高版本。

已弃用

• #11512: 不推荐使用 sphinx.util.md5 和 sphinx.util.sha1 。使用 hashlib 取而代之的是。

• #11526: 不推荐使用 sphinx.testing.path 。使用 os.path 或 pathlib 取而代之的是。

• #11528: 不推荐使用 sphinx.util.split_index_msg 和 sphinx.util.split_into 。使用 sphinx.util.index_entries.split_index_msg 取而代之的是。

• 不推荐使用 sphinx.builders.html.Stylesheet 和 sphinx.builders.html.Javascript 。使用 sphinx.application.Sphinx.add_css_file() 和 sphinx.application.Sphinx.add_js_file() 取而代之的是。

• #11582: 不推荐使用 sphinx.builders.html.StandaloneHTMLBuilder.css_files 和 sphinx.builders.html.StandaloneHTMLBuilder.script_files 。使用 sphinx.application.Sphinx.add_css_file() 和 sphinx.application.Sphinx.add_js_file() 取而代之的是。

• #11459: 不推荐使用 sphinx.ext.autodoc.preserve_defaults.get_function_def() 。作者：Patch by Bénédikt Tran.

新增特征

• #11526: 支持 os.PathLike 类型和 pathlib.Path 更多地方的物件。

• #5474: 覆盖范围：打印汇总统计表。作者声明：Jorge Leitao；

• #6319: 视频码：添加 viewcode_line_numbers 以控制是否将行号添加到呈现的源代码中。本·克里克勒所著的Patch。

• #9662: 添加 :no-typesetting: 选项以取消文本输出，而仅创建可链接的锚点。作者拉托莎·马尔特巴。

• #11221: C++：支持目录中的域对象。作者声明：Rouslan Korneychuk；

• #10938: 文档测试：添加 doctest_show_successes 选择。由Trey Hunner制作的Patch。

• #11533: 增列 :no-index: ， :no-index-entry: ，以及 :no-contents-entry: 。

• #11572: 改进 debug 记录检测到文件过期的原因。作者：Eric Larson。

• #10678: 发射 source-read 方法读取的文件的事件 include 指令。Halldor Fannar的Patch。

• #11570: 使用时使用缩写名称 PEP 585 内置泛型。作者：Riccardo Mori。

• #11300: 改进 SigElementFallbackTransform 备用逻辑和签名文本元素节点。看见 the documentation 了解更多详细信息。作者：Patch by Bénédikt Tran.

• 允许使用运行Sphinx python -m sphinx build ... 。

修复错误

• #11077: GRAPVIZ：修复图表中的相对链接。作者声明：by Ralf Grubenmann；

• #11529: LaTeX生成器中的行块输出虚假的空令牌。作者：禤浩焯·沃尔默。

• #11196: 自动摘要：摘要行提取失败，并显示“例如”

• #10614: 修复了继承图中的一些错误，这些错误会导致链接丢失或断开。作者：阿尔伯特·施瓦茨。

• #9428: 运行时排除替换定义 gettext 建筑商。作者：Alvin Wong。

• #10795: 如果出现以下情况，则引发描述性错误 graphviz_dot 是虚假的。

• #11546: 翻译后的节点与其原始文本相同，现在用 translated=True 属性。

• #10049: 超文本标记语言：将链接锚中标题文本的“Permarink”更改为“Link”。

• #4225: 放松对词法分析失败的Pygments解析。

• #11246: 允许在文档字符串的第一行和单行类型的注释中使用行内链接 #: :meta ...: 在使用时 sphinx.ext.napoleon 。作者：Patch by Bénédikt Tran.

• #10930: 突出显示搜索结果页面上的所有搜索词。作者声明：by Dmitry Shachnev。

• #11473: 类型批注包含 Literal 枚举值现在可以正确呈现。作者：Patch by Bénédikt Tran.

• #11591: 修复中对C覆盖率的支持 sphinx.ext.coverage 分机。作者：Stephen Finucane。

• #11594: HTML主题：在较小设备上的水平滚动增强 agogo 主题。作者：Patch by Lukas Engelter。

• #11459: 修复了中对异步和lambda函数的支持 sphinx.ext.autodoc.preserve_defaults 。作者：Patch by Bénédikt Tran.

测试

• #11577: Pytest：“xPASS”测试失败。

• #11577: Pytest：使用portlib导入模式。

• #11577: Pytest：设置PYTHONWARNINGS=ERROR。

• #11577: Pytest：设置严格的配置和严格的标记。

版本7.1.2(2023年8月2日发布)

修复错误

• #11542: 链接检查：正确尊重 linkcheck_anchors 并且不虚假地报告验证锚的失败。詹姆斯·爱迪生的补丁。

版本7.1.1(2023年7月27日发布)

修复错误

• #11514: 修整 SOURCE_DATE_EPOCH 在多行版权页脚。作者：Patch by Bénédikt Tran.

版本7.1.0(2023年7月24日发布)

不兼容的更改

• 不再签署版本，因为 change in PyPI policy 。

已弃用

• #11412: 发出有关使用过时的特定于Python的索引项类型的警告(即， module ， keyword ， operator ， object ， exception ， statement ，以及 builtin ))中 index 指令，并将删除版本设置为Sphinx9.Patch by Adam Turner。

新增特征

• #11415: 使用CRC32算法将校验和添加到生成的HTML中包含的JavaScript和CSS资产URI。

• require_sphinx() 现在允许将版本要求指定为 (major, minor) 。

• #11011: 允许配置对象签名的行长限制，通过 maximum_signature_line_length 以及特定领域的变体。如果签名的长度(以字符为单位)大于配置的限制，则签名中的每个参数将被拆分到各自的逻辑行。例如，该行为也可以由对象描述指令上的选项来控制 py:function:single-line-parameter-list 。作者：Thomas Louf，Adam Turner和Jean-François B.

• #10983: 支持脚注块中的多行版权声明。斯蒂芬妮·莫林的Patch

• sphinx.util.display.status_iterator 现在使用ANSI控制代码清除当前行，而不是使用空格字符叠印。

• #11431: 链接检查：将SSL故障视为断开的链接。詹姆斯·爱迪生的补丁。

• #11157: 请保留 translated 属性在已翻译的节点上。

• #11451: 改进了使用时显示的回溯 sphinx-build -T 在并行构建中。Patch by Bénédikt Tran

• #11324: 链接检查：使用基于会话的HTTP请求。

• #11438: 添加对 py:class 和 py:function PEP 695(泛型类和函数声明)和PEP 696(默认类型参数)的指令。多线路支持 (#11011 )被启用用于类型参数列表并且可以在对象描述指令上被本地控制，例如， py:function:single-line-type-parameter-list 。作者：Patch by Bénédikt Tran.

• #11484: 链接检查：允许在每个URL基础上忽略HTML锚，方法是 linkcheck_anchors_ignore_for_url 同时仍然检查页面本身的有效性。Patch by Bénédikt Tran

• #1246: 通过新的替换添加翻译进度统计和检查支持 (|translation progress| )和新的配置变量 (translation_progress_classes )。这使得能够确定文档中已翻译元素以及其余已翻译和未翻译元素的百分比。

修复错误

• 恢复了 footnote-reference 类，该类已在最新(未发布)版本的Docutils中删除。

• #11486: 使用 RFC 8081 EPUB生成器中的字体文件MIME类型。使用正确的MIME类型将防止 epubcheck 并将生成有效的EPUB。

• #11435: 使用微秒级的时间戳进行过时文件检测 BuildEnvironment.get_outdated_files 。

• #11437: 当出现以下情况时，以reStructiredText角色开始的顶级标题现在可以正确呈现 rst_prolog 已经设置好了。以前，由于序言文本插入到文档中的位置，以下面开头的文件可能会不正确地呈现。

  :mod:`lobster` -- The lobster module
  ====================================
  
  ...
  

  作者：Patch by Bénédikt Tran.

• #11337: 修好一个 MemoryError 在……里面 sphinx.ext.intersphinx 在使用时 None 或 typing.* 作为内联类型引用。Patch by Bénédikt Tran(Picnixz)

测试

• #11345: 始终删除 docutils.conf 运行时在测试目录中 SphinxTestApp.cleanup() 。

版本7.0.1(2023年5月12日发布)

依赖关系

• #11411: 支持 Docutils 0.20 。亚当·特纳的帕奇。

修复错误

• #11418: 清除对的剩余引用 sphinx.setup_command 在移除对setupTools的支持之后。作者声明：Patch by Willem Mulder。

版本7.0.0(2023年4月29日发布)

不兼容的更改

• #11359: 删除长期不推荐使用的别名 MecabSplitter 和 DefaultSplitter 在……里面 sphinx.search.ja 。

• #11360: 删除已弃用的 make_old_id 域对象描述类中的函数。

• #11363: 删除SetupTools集成 (build_sphinx 钩住 setup.py )。

• #11364: 删除已弃用的 sphinx.ext.napoleon.iterators 模块。

• #11365: 删除对 jsdump 格式设置为 sphinx.search 。

• #11366: 制作 locale 一个必需的参数 sphinx.util.i18n.format_date() 。

• #11370: 删除已弃用的 sphinx.util.stemmer 模块。

• #11371: 删除已弃用的 sphinx.pycode.ast.parse() 功能。

• #11372: 删除已弃用的 sphinx.io.read_doc() 功能。

• #11373: 已删除，已弃用 sphinx.util.get_matching_files() 功能。

• #11378: 删除已弃用的 sphinx.util.docutils.is_html5_writer_available() 功能。

• #11379: 使之成为 env 参数为 Builder 所需的子类。

• #11380: 自动汇总：始终发出分组的导入例外。

• #11381: 删除已弃用的 style 用于HTML模板的键。

• #11382: 删除已弃用的 sphinx.writers.latex.LaTeXTranslator.docclasses 属性。

• #11383: 删除已弃用的 sphinx.builders.html.html5_ready 和 sphinx.builders.html.HTMLTranslator 属性。

• #11385: 删除对HTML4输出的支持。

版本6.2.1(2023年4月25日发布)

修复错误

• #11355: 恢复默认类型的 nitpick_ignore 和 nitpick_ignore_regex 至 list 。

版本6.2.0(2023年4月23日发布)

依赖关系

• 需要Docutils 0.18.1或更高版本。

不兼容的更改

• LaTeX: removal of some internal TeX \dimen registers (not previously publicly documented) as per 5.1.0 code comments in sphinx.sty: \sphinxverbatimsep, \sphinxverbatimborder, \sphinxshadowsep, \sphinxshadowsize, and \sphinxshadowrule. (refs: #11105)

• 移除 .egg 来自pycode的支持 ModuleAnalyser ； Python 彩蛋是一种现已过时的二进制分发格式

• #11089: 删除中不推荐使用的代码 sphinx.builders.linkcheck 。丹尼尔·伊迪斯的补丁

• 删除仅限内部使用 sphinx.locale.setlocale

已弃用

• #11247: 不推荐使用旧版本 intersphinx_mapping 格式

• sphinx.util.osutil.cd 不受欢迎，而赞成 contextlib.chdir 。

新增特征

• #11277: autoproperty 允许将返回类型指定为类型注释(例如， # type: () -> int )。Patch by Bénédikt Tran

• #10811: 自动汇总：扩展 __all__ 导入成员以在下列情况下呈现模板选项 autosummary_ignore_module_all 设置为 False 。Clement Pinard著的Patch

• #11147: 添加 content_offset 参数设置为 nested_parse_with_titles() ，允许在嵌套分析期间使用正确的行号。作者：Jeremy Maitin-Shepard

• 更新到Unicode CLDR 42

• 添加 --jobs 的同义词 -j 。雨果·范·凯门纳德的补丁

• LaTeX：一个命令 \sphinxbox 对于带有(可能是圆角的)框的文本元素的样式，添加了可选的背景色和阴影。看见 这个 \sphinxbox 命令 。(参考文献： #11224 )

• LaTeX：添加 \sphinxstylenotetitle 、. \sphinxstylewarningtitle ，...，以获得额外的加价释放 \sphinxstrong 用于其他用途。看见 宏指令 。(参考文献： #11267 )

• LaTeX： note ， hint ， important 和 tip 现在可以将每个警告设置为其他警告的样式，即可能使用背景色、单独的边框宽度和填充、可能的圆角以及可选的阴影。看见 其他类似于css的内容 'sphinxsetup' 钥匙 。(参考文献： #11234 )

• LaTeX：告诫和 topic (及 contents )指令，而且不仅 code-block 、支持 box-decoration-break=slice 。

• LaTeX：让圆形框最多支持4个不同的边框宽度(参考： #11243 )

• LaTeX：新选择 noteTextColor ， noteTeXextras 等人的研究。看见 其他类似于css的内容 'sphinxsetup' 钥匙 。

• Latex ：在圆形盒子中支持椭圆角。(参考文献： #11254 )

• #11150: 当词法分析失败时，在突出显示警告时包括源位置。作者：Jeremy Maitin-Shepard

• #11281: 支持 imgmath_latex = 'tectonic' 或 = 'xelatex' 。迪米塔尔·迪米特罗夫的补丁

• #11109, #9643: 增列 python_display_short_literal_types 用于压缩渲染的选项 Literal 类型。

修复错误

• #11079: LaTeX：具有Align属性的人物可能会消失，并奇怪地影响以下列表

• #11093: LaTeX：修复当一个或多个REST标签直接位于 py:module 或 automodule 指令。Patch by Bénédikt Tran(Picnixz)

• #11110: LaTeX：如果它们的文件具有相同的基本名称，并且使用后期转换，则这些图形在LaTeX PDF中会消失。Aaron-Cooper的补丁

• LaTeX：修复从阴影到圆框边框的潜在颜色泄漏，如果设置了阴影颜色但未设置边框颜色

• LaTeX：修复代码块帧相对于内容的意外1pt向上垂直移动(当使用圆角时)

• #11235: LaTeX：添加 \color 主题(或告诫)中的内容可能会导致颜色泄漏到分页符的阴影和边框

• #11264: LaTeX：缺少冒号前的空格，在For seealso 法语指令

• #11268: LaTeX：长表格，左对齐打破了PDF中当前的列表缩进上下文。多亏了Picnixz。

• #11274: LaTeX：外部链接未正确转义为 \sphinxupquote 兼容性

• #11147: 修复对象描述内容中的源文件/行号信息以及 nested_parse_with_titles 。作者声明：Jeremy Maitin-Shepard；

• #11192: 恢复正确的并行搜索索引构建。作者：Jeremy Maitin-Shepard

• 使用新的传递函数 tx 客户端

测试

• 在发出任何Python警告时测试失败

• 迁移剩余部分 unittest.TestCase 样式测试函数用于最新样式

• 删除依赖于安装工具的测试

版本6.1.3(2023年1月10日发布)

修复错误

• #11116: 已恢复到以前的Sphinx 5节点复制方法

• #11117: 从Sphinx 6.1.0恢复对并行图像处理的更改

• #11119: 抑制 ValueError 在 linkcheck 建设者

版本6.1.2(2023年1月7日发布)

修复错误

• #11101: LaTeX: div.topic_padding key of sphinxsetup documented at 5.1.0 was implemented with name topic_padding

• #11099: LaTeX： shadowrule 自Sphinx 5.1.0以来，Sphinxsetup键导致PDF构建崩溃

• #11096: LaTeX： shadowsize 自Sphinx 5.1.0以来，Sphinxsetup键导致PDF构建崩溃

• #11095: LaTeX：阴影 topic 和 contents 自Sphinx 5.1.0以来不在页边距中的框

• #11100: 修复了在并行模式下运行时复制图像的问题。

版本6.1.1(2023年1月5日发布)

修复错误

• #11091: 修整 util.nodes.apply_source_workaround 为 literal_block 节点或节点的父节点中没有源信息的节点。

版本6.1.0(2023年1月5日发布)

依赖关系

• 通过了 Ruff 代号林特。

不兼容的更改

• #10979: GetText：删除了对中的多元化的支持 get_translation 。这是未使用的，并且使其他更改复杂化 sphinx.locale 。

已弃用

• sphinx.util 功能：

  • 已重命名 sphinx.util.typing.stringify() 至 sphinx.util.typing.stringify_annotation()

  • 挪动 sphinx.util.xmlname_checker() 至 sphinx.builders.epub3._XML_NAME_PATTERN

  已移至 sphinx.util.display ：

  • sphinx.util.status_iterator

  • sphinx.util.display_chunk

  • sphinx.util.SkipProgressMessage

  • sphinx.util.progress_message

  已移至 sphinx.util.http_date ：

  • sphinx.util.epoch_to_rfc1123

  • sphinx.util.rfc1123_to_epoch

  已移至 sphinx.util.exceptions ：

  • sphinx.util.save_traceback

  • sphinx.util.format_exception_cut_frames

新增特征

• 在写入阶段在构建环境中缓存文档树。

• 使所有写入阶段的任务都支持并行执行。

• #11072: 使用PEP 604 (X | Y )的显示约定 typing.Optional 和 typing.Optional 在Python域和AutoDoc中的类型。

• #10700: AutoDoc：文档 typing.NewType() 类型是类，而不是“数据”。

• 在读取和写入阶段之间缓存文档树。

修复错误

• #10962: Html：修复多字关键字名称查找表。

• 修复了对Python3.12 Alpha 3的支持( enum 模块)。

• #11069: 超文本标记语言主题：删除了过时的“快捷方式”链接关系关键字。

• #10952: 在程序中断时正确终止并行进程。

• #10988: 加快速度 TocTree.resolve() 通过更高效的复制。

• #6744: LaTeX：对SeeAlso指令的支持应该通过允许样式的环境来实现。

• #11074: LaTeX：无法将sphinxnote更改为使用从5.1.0开始的sphinxheavybox

版本6.0.1(2023年1月5日发布)

依赖关系

• 需要Pygments 2.13或更高版本。

修复错误

• #10944: Imgath：修复解析嵌套文件夹中文件的图像路径。

版本6.0.0(2022年12月29日发布)

依赖关系

• #10468: 放弃对Python3.6的支持

• #10470: 放弃对Python3.7、Docutils 0.14、Docutils 0.15、Docutils 0.16和Docutils 0.17的支持。亚当·特纳的《补丁》

不兼容的更改

• #7405: 删除了jQuery和undercore re.js JavaScript框架。

  从Sphinx 6.0开始，这些框架不再自动注入主题。如果开发的主题或扩展使用 jQuery ， $ ，或 $u 对于全局对象，您需要将您的JavaScript更新为现代标准，或者使用下面的缓解措施。

  第一个选项是使用 sphinxcontrib.jquery 扩展，它是由Sphinx团队和贡献者开发的。要使用此功能，请添加 sphinxcontrib.jquery 发送到 extensions 列在 conf.py ，或致电 app.setup_extension("sphinxcontrib.jquery") 如果您开发了Sphinx主题或扩展。

  第二种选择是手动确保框架存在。要重新添加jQuery和undercore.js，您需要复制 jquery.js 和 underscore.js 从… the Sphinx repository 致您的 static 目录，并将以下内容添加到您的 layout.html ：

  {%- block scripts %}
      <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
      <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
      {{ super() }}
  {%- endblock %}
  

  亚当·特纳的帕奇。

• #10471, #10565: 删除了Sphinx 6.0中计划删除的不推荐使用的API。看见 不赞成的API 了解更多细节。亚当·特纳的帕奇。

• #10901: C域：删除对v3之前的样式类型指令和角色的解析支持。同时删除关联的配置变量 c_allow_pre_v3 和 c_warn_on_allowed_pre_v3 。亚当·特纳的帕奇。

新增特征

• #10924: LaTeX：对表和代码块采用更好看的默认设置。看见 latex_table_style 以及 pre_border-radius 和 pre_background-TeXcolor 其他类似于css的内容 'sphinxsetup' 钥匙 对于以前的默认设置，以及如果需要如何重新制定它们。

修复错误

• #10984: LaTeX：文档 latex_additional_files 包含的文件的行为 .tex 分机。

版本5.3.0(2022年10月16日发布)

• #10759: LaTeX：添加 latex_table_style 并支持 'booktabs' ， 'borderless' ，以及 'colorrows' 风格。(感谢Stefan Wiehler的初始拉取请求 #6666 ， #6671 )

• #10840: 可以交叉引用，包括如下选项的值 :option:`--module=foobar ， `--module[=foobar]` ，或 `--module foobar` `。作者声明：Patch by Martin Liska。

• #10881: AutosectionLabel：将生成的段标签记录到调试日志中。

• #10268: 正确的URI转义图像文件名。

• #10887: 域：允许在所有对象描述指令的所有内容中包含部分(例如 py:function )。亚当·特纳的《补丁》

版本5.2.3(2022年9月30日发布)

• #10878: Fix base64 image embedding in sphinx.ext.imgmath

• #10886: 增列 :nocontentsentry: 标志和全局域目录条目控制选项。亚当·特纳的《补丁》

版本5.2.2(2022年9月27日发布)

• #10872: 将AutoDoc模块的链接目标恢复到内容顶部。作者：Dominic Davis-Foster。

版本5.2.1(2022年9月25日发布)

修复错误

• #10861: 始终正常化 pycon3 词法分析器到 pycon 。

• 使用以下工具修复 sphinx.ext.autosummary 其中的模块在模块级别的文档字符串中包含标题。

版本5.2.0.post0(2022年9月24日发布)

• 为Debian维护人员重新创建了源代码tarball。

版本5.2.0(2022年9月24日发布)

依赖关系

• #10356: Sphinx现在使用声明性元数据 pyproject.toml 使用Pypa创建包 flit 作为构建后端的项目。亚当·特纳的帕奇。

已弃用

• #10843: 支持HTML4输出。亚当·特纳的帕奇。

新增特征

• #10738: 拿破仑：使用‘of’添加对文档字符串类型的支持，如 type of type 。示例： tuple of int 。

• #10286: C++，支持不仅需要模板参数列表和声明之间的子句。

• #10755: 链接检查：检查使用 url 选择。

• #10781: 允许 ref 要与定义和字段一起使用的角色。

• #10717: HTML搜索：在搜索结果中提高全标题和副标题匹配的优先级

• #10718: 超文本标记语言搜索：将搜索结果分数保存到超文本标记语言元素进行调试

• #10673: 使toctree接受‘genindex’、‘modindex’和‘search’文档名称

• #6316, #10804: 将域对象添加到目录中。亚当·特纳的《补丁》

• #6692: HTMLSearch：包括显式 index 搜索索引和搜索结果中的指令索引项。亚当·特纳的《补丁》

• #10816: Imgath：允许以Base64格式将图像嵌入到HTML中

• #10854: HTMLSearch：使用浏览器本地存储进行高亮显示控制，停止在URL查询字符串中存储高亮显示参数。亚当·特纳的帕奇。

修复错误

• #10723: LaTeX：5.1.0制造了“Sphinx” verbatimwithframe=false 变得无效。

• #10257: C++，确保非专门化模板参数表示的一致性。

• #10729: C++，修复了某些非类型模板参数包的解析。

• #10715: Revert #10520: "Fix" use of sidebar classes in agogo.css_t

版本5.1.1(2022年7月26日发布)

修复错误

• #10701: 修复新版本中的ValueError deque 基于 sphinx.ext.napolean 迭代器实现。

• #10702: 恢复与第三方建筑商的兼容性。

版本5.1.0(2022年7月24日发布)

依赖关系

• #10656: 支持 Docutils 0.19 。亚当·特纳的帕奇。

已弃用

• #10467: 已弃用 sphinx.util.stemmer 赞成…… snowballstemmer 。亚当·特纳的帕奇。

• #9856: 已弃用 sphinx.ext.napoleon.iterators 。

新增特征

• #10444: HTMLTheme：允许通过 stylesheet 设置在 theme.conf 或通过设置 html_style 到字符串的可迭代。

• #10366: STD域：添加对强调占位符的支持 option 指令通过新的 option_emphasise_placeholders 配置选项。

• #10439: STD域：在显示警告时使用某些变量的REPR，使空格问题更容易识别。

• #10571: 快速入门：减少生成的 conf.py 文件。Patch by Pradyun Gedam。

• #10648: LaTeX：类似于css的附加内容 'sphinxsetup' 按键允许为每个代码块配置四个单独的边框宽度、四个填充、四个角半径、阴影(可能是插图)、边框、背景、阴影的颜色、主题、注意、注意、危险、错误和警告指令。

• #10655: LaTeX：解释LatinRules.xdy中的非标准编码

• #10599: HTML主题：将连续的脚注换行到 <aside> 元素，以便更轻松地设置样式。这与Docutils 0.19中引入的行为相匹配。亚当·特纳的帕奇。

• #10518: 配置：添加 include_patterns 与之相对的 exclude_patterns 。亚当·特纳的帕奇。

修复错误

• #10594: HTML主题：如果使用Docutils 0.18+，则字段冒号加倍

• #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due to missing Node.findall()

• #10506: LaTeX：在插图标题中突出显示行内代码角色时出现构建错误(参考： #10251 )

• #10634: Make-P(Pdb)选项在处理从事件触发的异常时效果更好

• #10550: PY域：修复未解析各种运算符时出现的虚假空格 (+ ， - ， ~ ，以及 ** )。由Adam Turner制作的补丁(参考： #10551 )。

• #10460: 日志记录：始终将节点源位置显示为绝对路径。

• 超文本标记搜索：超文本标记显示为对象名称的一部分

• HTMLSearch：搜索片段不应折叠

• HTMLSearch：获取搜索片段时发出小错误

• HTML搜索：标题链接的标记显示在搜索结果中

• #10520: HTML主题：修复中边栏类的使用 agogo.css_t 。

• #6679: 修复在agogo主题中包含隐藏的目录树的问题。

• #10566: HTML主题：修复ENABLE_SEARCH_SHORTSHORT不起作用

• #8686: LaTeX：文本可能会从页面末尾的代码块中掉出来，并在下一页留下人工制品

• #10633: LaTeX：用户注入 \color 主题或警告框中的命令可能会由于上游原因导致PDF中的颜色泄漏 framed.sty 错误

• #10638: LaTeX：突出显示代码的边框彩色方框(例如，使用Pygments样式突出显示的差异 'manni' )继承代码块帧的厚度

• #10647: LaTeX：只有一个 \label 为以下对象生成 desc_signature 节点，即使它有多个节点ID

• #10579: I18N：在转换RAW指令时引发Unound LocalError

• #9577, #10088: PY域：修复使用时重复的Python引用的警告 :any: 和自驾车。

• #10548: HTML搜索：修复次要的摘要问题。

版本5.0.2(2022年6月17日发布)

新增特征

• #10523: HTML主题：将Docutils的版本信息元组作为模板变量公开， docutils_version_info 。亚当·特纳的帕奇。

修复错误

• #10538: AutoDoc：具有文档字符串的继承类属性被记录下来，即使 autodoc_inherit_docstring 已禁用

• #10509: 自动汇总：共享库的自动汇总失败

• #10497: PY域：无法以文字形式解析字符串。亚当·特纳的帕奇。

• #10523: HTML主题：修正Docutils 0.18+中引文引用的双括号。亚当·特纳的帕奇。

• #10534: Docutils 0.18+中缺少nav.content的css。亚当·特纳的帕奇。

版本5.0.1(2022年6月03日发布)

修复错误

• #10498: 如果节点没有行号，则在对警告消息进行排序时引发getText：TypeError。亚当·特纳的帕奇。

• #10493: 超文本标记语言主题： topic 指令在Docutils 0.18中呈现不正确。亚当·特纳的帕奇。

• #10495: IndexError是为 kbd 有分隔符的角色。亚当·特纳的帕奇。

版本5.0.0(2022年5月30日发布)

依赖关系

5.0.0 b1

• #10164: 支持 Docutils 0.18 。亚当·特纳的帕奇。

不兼容的更改

5.0.0 b1

• #10031: 自动汇总： sphinx.ext.autosummary.import_by_name() 现在提高 ImportExceptionGroup 而不是 ImportError 当它无法导入目标对象时。如果您的扩展使用该函数导入Python对象，请处理异常。作为一种解决办法，您可以通过以下方式禁用行为 grouped_exception=False V7.0之前的关键字参数。

• #9962: 文本信息：通过以下方式自定义强调文本的样式 @definfoenclose 不支持该命令，因为该命令自tex Info 6.8起已弃用

• #2068: intersphinx_disabled_reftypes 已将缺省值从空列表更改为 ['std:doc'] 作为避免太令人惊讶的沉默的Sphinx决议。要迁移：要么将显式清单名称添加到intersphinx应解析的引用中，要么将此配置变量的值显式设置为空列表。

• #10197: 超文本标记语言主题：约简 body_min_width 将基本主题设置为360px

• #9999: LaTeX：用CR将术语与其定义分开(参考： #9985 )

• #10062: Change the default language to 'en' if any language is not set in conf.py

5.0.0最终版

• #10474: language 不接受 None 就像它的价值一样。的默认值为 language 变成了 'en' 现在。作者：Adam Turner和Takeshi Komiya。

已弃用

5.0.0 b1

• #10028: 从Sphinx 6.0开始，jQuery和undercore.js将不再自动注入主题。如果开发的主题或扩展使用 jQuery ， $ ，或 $u 全局对象，您需要更新您的JavaScript或使用下面的缓解措施。

  要重新添加jQuery和undercore.js，您需要复制 jquery.js 和 underscore.js 从… the Sphinx repository 致您的 static 目录，并将以下内容添加到您的 layout.html ：

  {%- block scripts %}
      <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
      <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
      {{ super() }}
  {%- endblock %}
  

  亚当·特纳的帕奇。

• SetupTools集成。这个 build_sphinx 为了遵循setupTools团队的策略，setup.py的子命令被标记为不推荐使用。

• 这个 locale 的论点 sphinx.util.i18n:babel_format_date() 成为必需的

• 这个 language 的论点 sphinx.util.i18n:format_date() 成为必需的

• sphinx.builders.html.html5_ready

• sphinx.io.read_doc()

• sphinx.util.docutils.__version_info__

• sphinx.util.docutils.is_html5_writer_available()

• sphinx.writers.latex.LaTeXWriter.docclasses

新增特征

5.0.0 b1

• #9075: AutoDoc：默认为 autodoc_typehints_format 更改为 'smart' 。它将取消类型提示的前导模块名称(例如。 io.StringIO -> StringIO )。

• #8417: AutoDoc： :inherited-members: 选项现在接受多个类。通过将选项指定为，它允许同时取消模块上多个类的继承成员 automodule 指令

• #9792: AUTODOC：添加新选项 autodoc_typehints_description_target 包括未记录的返回值，但不包括未记录的参数。

• #10285: AutoDoc：未记录具有类型提示的SingleDispatch函数

• AutoDoc： autodoc_typehints_format 现在也适用于特性、数据、属性和类型变量边界。

• #10258: 自动汇总：将记录的模块属性识别为非导入

• #10028: 删除了内部使用的JavaScript框架(jQuery和undercore re.js)，并进行了现代化 doctools.js 和 searchtools.js 至EMCAScrip 2018。亚当·特纳的帕奇。

• #10302: C++，增加了对条件表达式的支持 (?: )。

• #5157, #10251: 内联代码可以通过以下方式突出显示 role 指令

• #10337: 通过在构建过程中缓存Publisher对象，使构建速度更快。亚当·特纳的帕奇。

修复错误

5.0.0 b1

• #10200: Apidoc：显示同时具有.pyx和.so文件的模块的重复子模块。作者：Adam Turner和Takeshi Komiya。

• #10279: AutoDoc：重载函数中仅关键字参数的默认值呈现为字符串文字

• #10280: AutoDoc： autodoc_docstring_signature 如果文档字符串具有多个签名，则意外地为构造函数生成返回值类型提示

• #10266: AutoDoc： autodoc_preserve_defaults 不适用于混合使用带/不带缺省值的仅关键字参数

• #10310: AutoDoc：使用模拟函数修饰时未记录类方法

• #10305: autodoc: Failed to extract optional forward-ref'ed typehints correctly via autodoc_type_aliases

• #10421: AutoDoc： autodoc_preserve_defaults 在类方法上不起作用

• #10214: Html：在以下情况下生成无效的语言标记 language 包含国家/地区代码(例如ZH_CN)

• #9974: Html：jQuery版本从3.5.1更新到3.6.0

• #10236: Html搜索：搜索结果中的对象重复

• #9962: Tex Info：不推荐使用的消息 @definfoenclose 关于生成文本信息文档的命令

• #10000: LaTeX：具有共同定义的术语表术语使用过多的垂直空格呈现

• #10188: LaTeX：交替乘法引用的脚注生成 ? 在pdf输出中

• #10363: LaTeX：Make 'howto' 标题页规则使用 \linewidth 为了与使用 twocolumn 类选项

• #10318: :prepend: 选项 literalinclude 指令不适用于 :dedent: 选择权

5.0.0最终版

• #9575: autodoc: The annotation of return value should not be shown when autodoc_typehints="description"

• #9648: autodoc: *args and **kwargs entries are duplicated when autodoc_typehints="description"

• #8180: AutoDoc：已忽略属性的DocString元数据

• #10443: EPub：ePub Builder无法检测.webp文件的MIME类型

• #10104: GetText：如果第三方分机未提供正确信息，则会显示重复的位置

• #10456: PY域： :meta: 如果文档字符串包含两个或更多元字段，则显示字段

• #9096: Sphinx-Build：并行构建的进度条的值错误

• #10110: Sphinx-Build：当Builder-Finish事件引发错误时，退出代码不会更改

版本4.5.0(2022年3月28日发布)

不兼容的更改

• #10112: Extlink：默认情况下禁用硬编码链接检测器

• #9993, #10177: 标准域：不允许通过引用内联目标 ref 角色

已弃用

• sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()

新增特征

• #10260: 使能 FORCE_COLOR 和 NO_COLOR 用于终端着色

• #10234: 自动汇总：将“自动汇总”css类添加到汇总表。

• #10125: Extlink：改进具有标题的参考文献的建议消息

• #10112: 文本链接：添加 extlinks_detect_hardcoded_links 启用硬编码链接检测器功能

• #9494, #9456: 超文本标记语言搜索：添加配置变量 html_show_search_summary 启用/禁用搜索摘要

• #9337: Html主题，添加选项 enable_search_shortcuts 这使得 / 作为快速搜索快捷方式 Esc 删除搜索突出显示的快捷方式。

• #10107: I18N：允许通过添加 #noqa 对每条翻译消息尾部的注释

• #10252: C++支持类、联合和枚举的属性。

• #10253: pep role now generates URLs based on peps.python.org

修复错误

• #9876: AutoDoc：无法记录从本机二进制模块生成的导入类

• #10133: AutoDoc：使用模拟模块进行类型批注时崩溃

• #10146: AutoDoc： autodoc_default_options 不支持 no-value 选择权

• #9971: AutoDoc：当目标对象由不可散列的对象批注时引发TypeError

• #10205: Extlink：无法在检查硬编码链接时编译regexp

• #10277: Html搜索：无法搜索短词(例如“使用”)

• #9529: LaTeX：命名为自动编号脚注(例如 [#named] )表示为一个问号。

• #9924: LaTeX：多行 cpp:function 指令在Latexpdf中具有较大的垂直间距

• #10158: LaTeX：对于未记录的变量/结构成员，从v4.4.0开始有过多的空格

• #10175: LaTeX：如果在不同的文档中也使用了该名称，则命名的脚注引用链接到错误的脚注

• #10269: 手册页：无法解析的标题 ref 交叉引用

• #10179: I18N：取消“RST本地化”警告

• #10118: ImgConverter：为远程URI调用了不必要的可用性检查

• #10181: 拿破仑：属性的显示方式与Google样式文档字符串的类属性类似 napoleon_use_ivar 已启用

• #10122: Sphinx-Build：Make.bat在显示帮助之前不检查Sphinx-Build命令的安装

版本4.4.0(2022年1月17日发布)

依赖关系

• #10007: 使用 importlib_metadata 适用于Python-3.9或更早版本

• #10007: Drop setuptools

新增特征

• #9075: AUTODOG：添加配置变量 autodoc_typehints_format 要取消函数签名的类型提示的前导模块名称(例如， io.StringIO -> StringIO )

• #9831: 自动汇总现在只记录模块的 __all__ 属性，如果 autosummary_ignore_module_all 设为 False 。默认行为没有变化。Autogen现在还支持此行为， --respect-module-all 换一下。

• #9555: 自动摘要：改进有关加载目标对象失败的错误消息

• #9800: Extlink：如果硬编码链接可由extlink替换，则发出警告，建议替换。

• #9961: 超文本标记语言：支持在其他超文本标记语言生成器中嵌套的超文本标记语言元素

• #10013: html: Allow to change the loading method of JS via loading_method parameter for Sphinx.add_js_file()

• #9551: HTMLSearch：“Hide Search Matters”链接从URL中移除“Highlight”参数

• #9815: HTML主题：将侧边栏组件包装在div中，以允许通过css定制它们的布局。

• #9827: I18N：根据翻译的术语对词汇表中的条目进行排序

• #9899: PY域：允许指定交叉引用说明符 (. 和 ~ )作为 :type: 选择权

• #9894: 链接检查：添加选项 linkcheck_exclude_documents 若要禁用匹配文档中的链接检查，请执行以下操作。

• #9793: Sphinx-Build：允许在MacOS和Python3.8+上使用MacOS中的并行构建功能

• #10055: Sphinx-Build：在以下情况下创建目录 -w 给出的选项

• #9993: 标准域：允许引用内联目标(例如 _`target name )通过 :rst:role:`ref 角色

• #9981: 标准域：从一般索引中剥离OPTION指令的值部分

• #9391: 文本信息：改进中的变量 samp 角色

• #9578: 纹理信息：添加 texinfo_cross_references 禁用交叉引用以提高独立读取器的可读性

• #9822 (及 #9062 )，添加新的Intersphinx角色 external 用于在外部项目中显式查找，而不解析到本地项目。

修复错误

• #9866: AutoDoc：已忽略导入类的DocComment

• #9883: AutoDoc：已忽略模拟对象的别名的停靠注释

• #9908: AutoDoc：调试消息显示在结合使用新类型和Python3.10的构建文档上

• #9968: AutoDoc：如果满足以下条件，则不显示实例变量 __init__ 方法具有仅位置参数

• #9194: AUTODOC：“输入”模块下的类型没有超链接

• #10009: AutoDoc：如果目标对象在获取文档字符串时出现错误，则崩溃

• #10058: autosummary: Imported members are not shown when autodoc_class_signature = 'separated'

• #9947: I18N：具有项目符号列表的主题指令不可翻译

• #9878: Mathjax：MathJax配置是在加载MathJax本身之后放置的

• #9932: 拿破仑：即使没有描述，也会生成空的“Returns”部分

• #9857: 生成的RFC链接使用过时的基本URL

• #9909: 禁止文字文本中的换行。

• #10061: HTMLTheme：主题添加的配置值不能从conf.py重写

• #10073: ImgConverter：为“data”URI调用了不必要的可用性检查

• #9925: LaTeX：禁止同时使用 'xelatex' 在内联和分析的文字的虚线处拆行

• #9944: LaTeX：某些嵌套声明的额外垂直空格

• #9940: LaTeX：Python域中的多功能声明在latexpdf输出中的垂直间距很小

• #10015: PY属性域：在INFO-FIELD-LIST中定义的类型没有超链接

• #9390: 文本信息：不在脚注内发出标签

• #9413: XML：交叉引用Python对象时生成了无效的XML

• #9979: 错误级别消息显示为警告消息

• #10057: 如果将项目放置到根目录中，则无法扫描文档

• #9636: 代码块： :dedent: 没有争辩就去掉了换行符

版本4.3.2(2021年12月19日发布)

修复错误

• #9917: 无论简单类型说明符的顺序如何，C和C++都会解析基本类型。

版本4.3.1(2021年11月28日发布)

新增特征

• #9864: mathjax: Support chnaging the loading method of MathJax to "defer" via mathjax_options

修复错误

• #9838: AutoDoc：在构建由函数工具修饰的函数的文档时引发AttributeError。lru_cache

• #9879: AutoDoc：在为具有无效属性的对象生成文档时引发AttributeError __doc__ 属性

• #9844: AutoDoc：无法处理用函数工具包装的函数。如果 autodoc_preserve_defaults 启用

• #9872: Html：AutoDoc签名和Docutils之间的类命名空间冲突0.17

• #9868: Imgath：如果dvisvgm命令无法转换公式，则崩溃

• #9864: Mathjax：无法通过MathJax v2呈现公式。MathJax的加载方法又回到了“异步”方法

版本4.3.0(2021年11月11日发布)

依赖关系

• 支持Python3.10

不兼容的更改

• #9649: searchindex.js ：嵌入的数据已更改格式，以允许不同域中具有相同名称的对象。

• #9672: 通过更多的Docutils节点实现了对Python域声明的呈现，以实现更好的CSS样式。它可能会打破现有的风格。

• #9672: 的签名 domains.python.PyObject.get_signature_prefix 已更改为返回节点列表，而不是纯字符串。

• #9695: domains.js.JSObject.display_prefix 已被更改为一种方法 get_display_prefix 它现在返回节点列表，而不是普通字符串。

• #9695: 通过更多的Docutils节点实现了对Javascript域声明的呈现，以实现更好的CSS样式。它可能会打破现有的风格。

• #9450: Mathjax：通过“延迟”策略加载MathJax

已弃用

• sphinx.ext.autodoc.AttributeDocumenter._datadescriptor

• sphinx.writers.html.HTMLTranslator._fieldlist_row_index

• sphinx.writers.html.HTMLTranslator._table_row_index

• sphinx.writers.html5.HTML5Translator._fieldlist_row_index

• sphinx.writers.html5.HTML5Translator._table_row_index

新增特征

• #9639: AutoDoc：支持异步生成器函数

• #9664: AutoDoc： autodoc-process-bases 支持将REST代码段作为基类注入

• #9691: C、添加了新的信息字段 retval 为 c:function 和 c:macro 。

• C++，添加了新的信息字段 retval 为 cpp:function 。

• #9618: I18N：添加 gettext_allow_fuzzy_translations 允许翻译“模糊”消息

• #9672: 更多关于Python域描述的CSS类

• #9695: 更多关于Java脚本域描述的CSS类

• #9683: 恢复删除 add_stylesheet() 原料药。它将一直保留到Sphinx 6.0版本

• #2068 <https://github.com/sphinx-doc/sphinx/issues/2068> _，添加 intersphinx_disabled_reftypes 用于禁用没有明确清单规范的交叉引用的Interphinx解析。可以禁用特定类型的交叉引用，例如， std:doc 或特定域中的所有交叉引用，例如， std:* 。

• #9623: Allow to suppress "toctree contains reference to excluded document" warnings using suppress_warnings

修复错误

• #9630: AutoDoc：如果满足以下条件，则无法构建交叉引用 primary_domain 不是‘Py’

• #9644: AutoDoc：从有问题的对象获取源信息时崩溃

• #9655: AutoDoc：意外警告具有文档注释的模拟对象

• #9651: AutoDoc：不生成退货类型字段 autodoc_typehints_description_target 当其信息字段列表包含 :returns: 字段

• #9657: AutoDoc：模拟对象的子类的基类不正确

• #9607: AutoDoc：泛型类的子类的基类检测不正确

• #9755: AutoDoc：显示别名的内存地址

• #9752: AutoDoc：未能检测到插槽属性的类型批注

• #9756: AutoDoc：如果类方法没有 __func__ 属性

• #9757: AutoDoc： autodoc_inherit_docstrings 不影响重写的类方法

• #9781: AutoDoc： autodoc_preserve_defaults 不支持十六进制数字

• #9630: 自动汇总：在以下情况下无法生成汇总表 primary_domain 不是‘Py’

• #9670: Html：修复带有特殊字符的下载文件

• #9710: HTML：嵌套表中偶数/奇数行的样式错误

• #9763: Html：参数名称及其类型批注在Html中未分开

• #9649: HTML搜索：当对象具有相同的名称但在不同的域中时，返回所有对象作为结果，而不是只返回一个。

• #7634: Intersphinx：对子目录中的文件的引用已中断

• #9737: LaTeX：hlist被呈现为包含“aggedright”文本的列表

• #9678: 链接检查：文件扩展名在警告中显示了两次

• #9697: PY域：注册了一个带括号的索引项 py:method 使用的指令 :property: 选择权

• #9775: py domain: Literal typehint was converted to a cross reference when autodoc_typehints='description'

• #9708: NEDS_EXTENSION无法正确检查两位版本

• #9688: 修复修补的Sphinx code 不认识 :class: 选择权

• #9733: 修复了在文档构建过程中记录处理程序刷新警告的问题

• #9656: 修复了没有错误消除子类型的警告

• Intersphinx，对于具有显式清单的未解析引用，例如， proj:myFunc ，在未解析的文本中保留库存前缀。

版本4.2.0(2021年9月12日发布)

新增特征

• #9445: AutoDoc：支持类属性

• #9479: AutoDoc：如果目标是模拟对象，则发出警告

• #9560: AutoDoc：允许引用Python3.10或更高版本中具有模块名称的Newtype实例

• #9447: html theme: Expose the version of Sphinx in the form of tuple as a template variable sphinx_version_tuple

• #9594: 手册页：如果描述为空，则不显示手册页的标题

• #9445: PY域： py:property 指令支持 :classmethod: 用于描述类属性的选项

• #9524: 测试：SphinxTestApp可以 builddir 作为一种论点

• #9535: C和C++支持更基本的类型，包括GNU扩展。

修复错误

• #9608: Apidoc：apidoc不为隐式命名空间包生成模块定义

• #9504: AutoDoc：如果目标类继承了具有 _name 属性

• #9537, #9589: AUTODOC：下面的一些对象 typing 标题为3.10的模块显示不好

• #9487: AUTODOC：未显示CACHED_PROPERTY的类型提示

• #9509: AutoDoc：在解析类型提示失败时引发AttributeError

• #9518: autodoc: autodoc_docstring_signature does not effect to __init__() and __new__()

• #9522: AutoDoc：PEP 585样式的文字提示有参数(例如 list[int] )没有很好地显示

• #9481: 自动摘要：某些警告包含不存在的文件名

• #9568: 自动摘要：正确汇总带上划线的分段标题

• #9600: 自动摘要：不会完全删除自动摘要表中包含逗号的类型批注

• #9481: C域：某些警告包含不存在的文件名

• #9481: CPP域：某些警告包含不存在的文件名

• #9456: Html搜索：如果无法获取页面内容，则在搜索结果中插入缩写标记

• #9617: Html搜索：如果浏览器速度慢，则会显示JS要求警告

• #9267: Html主题：按主题添加的css和js文件加载了两次。

• #9585: PY域： :type: 选项 py:property 指令不会创建超链接

• #9576: PY域：文本类型提示已转换为交叉引用

• #9535 备注：C++，修复了对作为函数指针的默认函数参数的解析。

• #9564: SmartQuotes：不调整语言突出显示的文本的排版 :code: 角色。

• #9512: Sphinx-Build：与Python3.10的头部崩溃

版本4.1.2(2021年7月27日发布)

不兼容的更改

• #9435: LinkCheck：禁用检查githorb.com上自动生成的锚(例如REST/降价文档中的锚点)

修复错误

• #9489: AutoDoc：自定义类型使用 typing.NewType 在标题为3.10的情况下显示不好

• #9490: AUTODOC：下面的一些对象 typing 标题为3.10的模块显示不好

• #9436, #9471: autodoc: crashed if autodoc_class_signature = "separated"

• #9456: HTMLSearch：HTMLCOPY_SOURCE无法控制搜索摘要

• #9500: LaTeX：无法在Windows上生成日语文档

• #9435: Linkcheck：无法检查githorb.com中的锚

版本4.1.1(2021年7月15日发布)

依赖关系

• #9434: Sphinxcontrib-htmlhelp-2.0.0或更高版本

• #9434: Sphinxcontrib-Series alizinghtml-1.1.5或更高版本

修复错误

• #9438: Html：在输出中未找到指定为文件的html徽标或收藏夹图标

版本4.1.0(2021年7月12日发布)

依赖关系

• 支持JJIA2-3.0

已弃用

• 这个 app 的论点 sphinx.environment.BuildEnvironment 成为必需的

• sphinx.application.Sphinx.html_theme

• sphinx.ext.autosummary._app

• sphinx.util.docstrings.extract_metadata()

新增特征

• #8107: autodoc: Add class-doc-from option to autoclass directive to control the content of the specific class like autoclass_content

• #8588: autodoc: autodoc_type_aliases now supports dotted name. It allows you to define an alias for a class with module name like foo.bar.BazClass

• #9175: AUTODOC：模块中未记录特殊成员

• #9195: AutoDoc：的论据 typing.Literal 错误地呈现

• #9185: AutoDoc： autodoc_typehints 允许 'both' 设置为允许在签名和描述中都包含类型提示

• #4257: AUTODOG：添加 autodoc_class_signature 将类条目和定义分开 __init__() 方法

• #8061, #9218: AutoDoc：支持别名类的变量注释

• #3014: AUTODOG：添加 autodoc-process-bases 修改类定义的基类

• #9272: AutoDoc：更好地呈现默认参数值的枚举值

• #9384: AutoDoc： autodoc_typehints='none' 现在擦除变量、属性和属性的类型提示

• #3257: 自动汇总：支持类的实例属性

• #9358: Html：向toctree项添加“Heading”角色

• #9225: Html：向方法/函数的返回类型提示添加SPAN标记

• #9129: html search: Show search summaries when html_copy_source = False

• #9307: HTMLSearch：防止在搜索字段中进行更正和完成

• #9120: Html主题：从可复制的文本中消除代码块的提示字符

• #9176: i18n: Emit a debug message if message catalog file not found under locale_dirs

• #9414: LaTeX：将xeCJKVerbAddon添加到中文文档的默认fvset配置

• #9016: Linkcheck：支持在githorb.com上检查主播

• #9016: 链接检查：添加新事件 linkcheck-process-uri 在检查超链接之前修改URI的步骤

• #6525: 链接检查：添加 linkcheck_allowed_redirects 将重定向到预期URL的超链接标记为“有效”

• #1874: NY域：支持联合类型，使用 | 在信息字段列表中

• #9268: PY域： python_use_unqualified_type_names 支持info-field-list中的类型字段

• #9097: 优化并行构建

• #9131: 增列 nitpick_ignore_regex 使用正则表达式忽略挑剔的警告

• #9174: Add Sphinx.set_html_assets_policy to tell extensions to include HTML assets in all the pages. Extensions can check this via Sphinx.registry.html_assets_policy

• C++，添加对

  • inline 变量，

  • consteval 函数、

  • constinit 变量，

  • char8_t,

  • explicit(<constant expression>) 说明符，

  • 文字中的数字分隔符，和

  • 占位符类型说明符中的约束，也称为。形容词句法(例如， Sortable auto &v )。

• 添加对文字中的数字分隔符的支持。

• #9166: LaTeX：支持LaTeX输出中的容器

修复错误

• #8872: AutoDoc：堆叠的单个派单呈现错误

• #8597: AutoDoc：仅具有元数据的Docking应被视为未记录

• #9185: AutoDoc：重载函数和方法的类型提示不准确

• #9250: AutoDoc：错误地分析了没有文档字符串的继承方法

• #9283: AUTODOC：AUTOATOR指令无法为没有任何注释的属性生成文档

• #9364: AutoDoc：默认参数值上的单个元素元组呈现错误

• #9362: AutoDoc：处理Tuple的子类时引发AttributeError [()]

• #9404: AUTODOC：通过AUTOCLASS指令处理类字典对象(不是类)时引发TypeError

• #9317: Html：按下左键会导致在第一页访问下一页

• #9381: Html：html_posicon和html_log的URL不起作用

• #9270: HTML主题：金字塔主题生成错误的徽标链接

• #9217: 手册页：生成的手册页目录的名称 man_make_section_directory 是不正确的

• #9350: 手册页：修复Samp角色顶部的关键字后未重置字体

• #9306: 当远程服务器根据Head请求关闭连接时，Linkcheck报告断开的链接

• #9280: PY域：未显示异常模块

• #9418: PY域：不带参数的可调用批注(例如 Callable[[], None]) 将在缺少括号的情况下呈现 (Callable[], None] )

• #9319: QuickStart：Make Shinx-QuickStart在conf.py已存在时退出

• #9387: XML：XML生成器忽略自定义访问者

• #9224: :param: 和 :type: 字段不支持包含空格的类型(例如 Dict[str, str] )

• #8945: 转换类型化字段时，请调用指定的角色，而不是创建单个外部参照。对于C和C++，请使用 expr 键入的字段的角色。

版本4.0.3(2021年7月05日发布)

新增特征

• C、增加C23关键字 _Decimal32 ， _Decimal64 ，以及 _Decimal128 。

• #9354: C，加法 c_extra_keywords 以允许在分析期间使用用户定义的关键字。

• 恢复删除 sphinx.util:force_decode() 在5.0期间再次成为可用的第三方扩展

修复错误

• #9330: 变更集域： versionchanged 如果内容是列表，则在构建pdf时会导致错误

• #9313: LaTeX：自4.0以来，合并单元格断开的复杂表格

• #9305: LaTeX：反斜杠可能会在日文引擎上导致不正确的任意列表pdf构建错误

• #9354: C、从关键字列表中删除特殊的宏名称。另请参阅 c_extra_keywords 。

• #9322: 在PropagateDescDomain转换时引发KeyError

版本4.0.2(2021年5月20日发布)

依赖关系

• #9216: 支持JJIA2-3.0

不兼容的更改

• #9222: 将UnderScotre.js更新到1.13.1

• #9217: 手册页：默认情况下停止在生成手册页上创建部分目录(请参见 man_make_section_directory )

修复错误

• #9210: 视图代码：如果在并行构建中发现不可导入的模块，则崩溃

• #9240: 如果不支持节点的扩展安装了缺失引用处理程序，则会引发Pending_xref_Condition的未知节点错误

版本4.0.1(2021年5月11日发布)

修复错误

• #9189: AutoDoc：从类的属性生成签名时引发ValueError时崩溃

• #9188: AUTOTOSUMALY：如果列表值设置为AUTOTOSUMARY_GENERATE，则发出警告

• #8380: HTMLSearch：搜索结果的标记已损坏

• #9198: I18N：运行COMPILE_CATALOG时，Babel发出错误

• #9205: PY DOMAIN：：CANONICAL：选项导致“多个目标交叉引用”警告

• #9201: WebSupport：引发UnfinedError：未定义‘css_tag’

版本4.0.0(2021年5月9日发布)

依赖关系

4.0.0b1

• 放弃对python3.5的支持

• 放弃Docutils 0.12和0.13支持

• LaTeX：添加 tex-gyre 字体依赖关系

4.0.0b2

• 支持Docutils 0.17。请注意，它更改了HTML生成器的输出。有些主题不支持它，您需要更新您的自定义css以升级它。

不兼容的更改

4.0.0b1

• #8539: AUTODOC：INFO-FIELD-LIST在以下情况下生成类描述 autodoc_typehints ='description' 和 autoclass_content ='class' 集

• #8898: Extlink：“%s”成为链接标题字符串中的必需关键字

• 域名： Index 类成为 abc.ABC 指示必须在具体类中重写的方法

• #4826: PY域：更改了Python对象的结构。添加布尔值以指示该Python对象是规范对象

• #7425: MathJax：MathJax已从2更改为3。使用自定义MathJax配置的用户可能必须设置旧的MathJax路径或更新其版本3的配置。请参见 sphinx.ext.mathjax 。

• #7784: I18N：图片的alt文本的msgid被更改

• #5560: 拿破仑： napoleon_use_param 也会影响“其他参数”部分

• #7996: 手册页：默认情况下，在构建手册页上创建一个部分目录(请参见 man_make_section_directory )

• #7849: html: Change the default setting of html_codeblock_linenos_style to 'inline'

• #8380: html search: search results are wrapped with <p> instead of <div>

• HTML主题：将Basic/layout.html中Documentation_options.js的脚本标记移动到 script_files 变数

• HTML主题：将Basic/layout.html中的CSS标记移动到 css_files 变数

• #8915: Html主题：发出警告 sphinx_rtd_theme 0.2.4或更早版本

• #8508: LaTeX：uPlatex成为日语文档的LaTeX_Engine的默认设置

• #5977: PY域： :var: ， :cvar: 和 :ivar: 字段不会创建交叉引用

• #4550: The align attribute of figure and table nodes becomes None by default instead of 'default'

• #8769: LaTeX重构：将sphinx.sted拆分成多个文件，并重命名在 latex 建立产出库

• #8937: 使用显式标题而不是<no title>

• #8487: Csv-table指令的：FILE：选项现在将绝对路径识别为源目录的相对路径

4.0.0b2

• #9023: 更改上的CSS类 cpp:expr 和 cpp:texpr 。

已弃用

• html_codeblock_linenos_style

• favicon 和 logo HTML模板中的变量

• sphinx.directives.patches.CSVTable

• sphinx.directives.patches.ListTable

• sphinx.directives.patches.RSTTable

• sphinx.ext.autodoc.directive.DocumenterBridge.filename_set

• sphinx.ext.autodoc.directive.DocumenterBridge.warn()

• sphinx.registry.SphinxComponentRegistry.get_source_input()

• sphinx.registry.SphinxComponentRegistry.source_inputs

• sphinx.transforms.FigureAligner

• sphinx.util.pycompat.convert_with_2to3()

• sphinx.util.pycompat.execfile_()

• sphinx.util.smartypants

• sphinx.util.typing.DirectiveOption

新增特征

4.0.0b1

• #8924: AutoDoc：支持 bound TypeVar的参数

• #7383: AutoDoc：支持属性的类型提示

• #5603: AutoDoc：当类有两个不同的名称时，允许使用其规范名称引用该类；规范名称和别名

• #8539: autodoc: Add autodoc_typehints_description_target to control the behavior of autodoc_typehints=description

• #8841: AutoDoc： autodoc_docstring_signature 将继续查找不带反斜杠字符的多个签名行

• #7549: 自动汇总：启用 autosummary_generate 默认情况下

• #8898: Extlink：链接标题字符串中允许%s

• #4826: PY域：添加 :canonical: 选项来描述定义对象的位置

• #7199: PY域：添加 python_use_unqualified_type_names 在可以解析的情况下隐藏Python引用的模块名称(试验性)

• #7068: PY域：添加 py:property 指令来描述属性

• #7784: I18N：默认情况下会翻译图像的Alt文本(没有 gettext_additional_targets 设置)

• #2018: Html： html_favicon 和 html_logo 现在接受图像的URL

• #8070: Html搜索：支持搜索2字词

• #9036: Html主题：允许继承搜索页面

• #8938: ImgConverter：显示命令可用性检查错误

• #7830: 添加调试日志以检测源代码和模板的更改

• #8201: 如果toctree包含重复条目，则发出警告

• #8326: master_doc is now renamed to root_doc

• #8942: C++，添加对C++20宇宙飞船操作符的支持， <=> 。

• #7199: 一个新的节点， sphinx.addnodes.pending_xref_condition 已添加。它可以用来按条件选择适当的参考内容。

4.0.0b2

• #8818: AutoDoc：超级级拥有 Any 争论导致挑剔的警告

• #9095: AutoDoc：在处理损坏的元类时引发TypeError

• #9110: AutoDoc：在py37+中未将GenericAlias的元数据呈现为引用

• #9098: HTML：对文档测试的复制范围保护在Safari中不起作用

• #9103: LaTeX：imgConverter：即使不需要转换也会运行

• #8127: PY域：INFO-FIELD-LIST中的省略号导致挑剔警告

• #9121: PY域：当文档上同时定义规范对象及其别名对象时，将发出重复警告

• #9023: 有关域描述的更多css类，请参阅 sphinx添加的doctree节点类 了解更多细节。

• #8195: mathjax: Rename mathjax_config to mathjax2_config and add mathjax3_config

修复错误

4.0.0b1

• #8917: AutoDoc：如果功能有错误，则发出警告 __globals__ 价值

• #8415: AutoDoc：未解析从其他模块导入的TypeVar(在Python3.7或更高版本中)

• #8992: AutoDoc：无法解析类型。TracebackType类型批注

• #8905: Html： html_add_permalinks=None 和 html_add_permalinks="" 被忽略

• #8380: html search: Paragraphs in search results are not identified as <p>

• #8915: 超文本标记语言主题：翻译 sphinx_rtd_theme 不起作用

• #8342: 如果为指令或角色指定了未知域(例如 :unknown:doc: )

• #7241: LaTeX: No wrapping for cpp:enumerator

• #8711: LaTeX：代码块中的反号触发TeXLive 2019后期的latexpdf构建警告(和字体更改)

• #8253: LaTeX：未定义大小的图形会超标(与以像素为单位明确设置大小的图像相比)(已修复 'pdflatex'/'lualatex' 仅)

• #8881: LaTeX：PDF中的书签面板深度不足以用于导航

• #8874: LaTeX：对两个次要的Pygments LaTeXForMatter输出问题的修复忽略Pygments样式

• #8925: LaTeX：3.5.0 verbatimmaxunderfull 设置未按预期工作

• #8980: LaTeX: missing line break in \pysigline

• #8995: LaTeX：传统 \pysiglinewithargsret 未正确计算可用水平空间，应使用不均匀的右样式

• #9009: LaTeX：带下划线的“Release”值导致无效LaTeX

• #8911: C++：删除中最长的匹配前缀 cpp_index_common_prefix 而不是第一个匹配的。

• 当关键字用作参数名称时，正确拒绝函数声明。

• #8933: 视图代码：无法在并行构建上创建反向链接

• #8960: C和C++，修复了函数参数列表中(成员)函数指针类型的呈现。

• C++，修复了数组声明符中的名称链接、指向成员(函数)声明符的指针以及 sizeof... 。

• C、修复数组声明符中的名称链接。

4.0.0b2

• C、C++、修复 KeyError 当一个 alias 指令是文件中的第一个C/C++指令，后面还有另一个C/C++指令。

4.0.0b3

• #9167: Html：无法将CSS文件添加到特定页面

版本3.5.5(正在开发中)

版本3.5.4(2021年4月11日发布)

依赖关系

• #9071: 将Docutils限制为0.16

修复错误

• #9078: AutoDoc：在Python3.10中，异步静态方法和类方法被视为非异步协同程序函数

• #8870, #9001, #9051: HTML主题：该样式不适用于Docutils 0.17

  • Toctree字幕

  • 的内容 sidebar 指令

  • 数字

版本3.5.3(2021年3月20日发布)

新增特征

• #8959: 在IMAGE指令中使用UNIX路径分隔符会混淆Windows上的Sphinx

版本3.5.2(2021年3月06日发布)

修复错误

• #8943: I18N：ES、El和HR中的翻译消息中断

• #8936: LaTeX：自定义LaTeX构建器失败，出现未知节点错误

• #8952: 指令中引发的异常会导致并行生成挂起

版本3.5.1(2021年2月16日发布)

修复错误

• #8883: AutoDoc：赋值时引发AttributeError __annotations__ 关于只读类

• #8884: Html：精简的js词干分析器没有包含在分发包中

• #8885: html: AttributeError is raised if CSS/JS files are installed via html_context

• #8880: 视图代码：在发现无法解析的python模块后，在增量构建时引发ExtensionError

版本3.5.0(2021年2月14日发布)

依赖关系

• Latex ： multicol (无论如何，它是官方latex2e基础发行版的必需部分)

不兼容的更改

• 将Underscore.js更新到1.12.0

• #6550: html: The config variable html_add_permalinks is replaced by html_permalinks and html_permalinks_icon

已弃用

• 视图代码扩展的Pending_xref节点

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.good

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers

• sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue

• sphinx.builders.linkcheck.node_line_or_0()

• sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()

• sphinx.ext.autodoc.directive.DocumenterBridge.reporter

• sphinx.ext.autodoc.importer.get_module_members()

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

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

• sphinx.writers.html.HTMLTranslator.permalink_text

• sphinx.writers.html5.HTML5Translator.permalink_text

新增特征

• #8022: AutoDoc：如果文档字符串包含，则AutoData和AutoAttribute指令不会显示变量的右手值 :meta hide-value: 在信息字段列表中

• #8514: AutoDoc：如果重载函数为省略号，则从实际实现中获取它们的缺省值

• #8775: AUTODOC：支持类型的联合运算符(PEP-604)在Python3.10或更高版本中

• #8297: AUTODOG：允许扩展 autodoc_default_options VIA指令选项

• #759: AutoDoc：添加新配置 autodoc_preserve_defaults 作为一种试验性的特征。它保留源代码中函数的默认参数值，并保持它们的可读性不被计算。

• #8619: Html：KBD角色为复合键生成可定制的Html标记

• #8634: html: Allow to change the order of JS/CSS via priority parameter for Sphinx.add_js_file() and Sphinx.add_css_file()

• #6241: HTML：允许在扩展调用时将JS/CSS文件添加到特定页面 app.add_js_file() 或 app.add_css_file() 在……上面 html-page-context 活动

• #6550: html: Allow to use HTML permalink texts via html_permalinks_icon

• #1638: 超文本标记语言：在术语表中添加固定链接图标

• #8868: 超文本标记语言搜索：海量列表的性能问题

• #8867: HTML搜索：将JavaScript词干分析器代码更新为最新版本的Snowball(v2.1.0)

• #8852: I18N：允许在myst-Parser中转换标题语法

• #8649: ImgConverter：如果Builder支持镜像类型，则跳过可用性检查

• #8573: napoleon: Allow to change the style of custom sections using napoleon_custom_sections

• #8004: 拿破仑：Google样式文档字符串中的类型定义在以下情况下呈现为引用 napoleon_preprocess_types 启用

• #6241: Mathjax：使用公式仅在文档中包含mathjax.js

• #8775: PY域：支持类型联合运算符(PEP-604)

• #8651: 标准域：对具有行内项目的题目的交叉引用已中断

• #7642: 标准领域：优化不区分大小写的术语匹配

• #8681: 视图代码：支持增量构建

• #8132: Add project_copyright as an alias of copyright

• #207: 现在 highlight_language 支持多种语言

• #2030: code-block 和 literalinclude 支持通过无参数自动删除 :dedent: 选择权

• C++，也是表达式和别名声明中的超链接运算符重载。

• #8247: 允许生产列表引用来自其他生产组的令牌

• #8813: 显示在事件处理程序上出现错误时是什么扩展(或模块)导致的

• #8213: C++：添加 maxdepth 选项以 cpp:alias 若要插入嵌套声明，请执行以下操作。

• C，加法 noroot 选项以 c:alias 仅呈现嵌套声明。

• C++，加法 noroot 选项以 cpp:alias 仅呈现嵌套声明。

修复错误

• #8727: Apidoc：如果命名空间中没有子模块，则不会生成命名空间模块文件

• #741: AutoDoc：继承的成员不适用于超类上的实例属性

• #8592: AutoDoc： :meta public: 不影响变量

• #8594: AUTODOG：空 __all__ 属性被忽略

• #8315: AutoDoc：无法解析结构。结构类型批注

• #8652: AutoDoc：如果模块包含无效的类型注释，则忽略模块中的所有变量注释

• #8693: AutoDoc：重载函数的默认值呈现为字符串

• #8134: AutoDoc：当被嘲笑的修饰者接受参数时崩溃

• #8800: AutoDoc：超类中未初始化的属性被识别为未记录

• #8655: autodoc: Failed to generate document if target module contains an object that raises an exception on hasattr()

• #8306: 自动汇总：使用：RECURSIVE：选项时，模拟模块被记录为空页

• #8232: Graphviz：如果图形文件在子目录中，则不呈现图像节点

• #8618: HTML：当复合键分隔符(-、+或^)用作击键时，KBD角色会生成不正确的HTML

• #8629: Html：两次显示html_use_openearch的类型警告

• #8714: “Caps Lock”未正确呈现的Html：KBD角色

• #8123: HTML搜索：修复对包含+的词语的搜索(需要不拆分为+的自定义搜索语言)

• #8665: Html主题：无法重写heme.conf中的global altoc_max深度

• #8446: 超文本标记语言：连续的空格显示为单个空格

• #8745: I18N：当转换消息添加新的自动脚注引用时，使用KeyError崩溃

• #4304: 链接检查：修复可能导致两次检查同一URL的可用性的争用条件

• #8791: 链接检查：不显示每个超链接的文档名称

• #7118: Sphinx-QuickStart：问题是如果libadline不可用，是否有Mojibake

• #8094: Tex Info：不复制包含文档的不同目录上的图像文件

• #8782: TODO：Todolist中的交叉引用被破坏

• #8720: 视图代码：在增量构建时为epub生成模块页面

• #8704: 视图代码：在Singlehtml之后的增量构建中生成锚点

• #8756: 视图代码：即使未引用，也会生成突出显示的代码

• #8671: highlight_options 不起作用了

• #8341: C、修复声明中名称的intersphinx查找类型。

• C、C++：通常修复Intersphinx和角色查找类型。

• #8683: html_last_updated_fmt 不支持UTC偏移量(%z)

• #8683: html_last_updated_fmt 为%Z生成错误的时区

• #1112: download 指定相对路径时，角色会创建重复的副本

• #2616 (第五项)：LaTeX：不能点击标题中的脚注，对于手动编号的脚注，只有编号相同的第一个脚注是超链接

• #7576: 带有法国巴别塔的 Latex 和回忆录CRASH：“定义中的非法参数编号 \FNH@prefntext “

• #8055: LaTeX(Docs)：Sphinx中LaTeX生成步骤的潜在显示错误(如何生成单列索引)

• #8072: LaTeX：指令 hlist 未在LaTeX中实现

• #8214: LaTeX：The index 角色和词汇表在LaTeX索引中生成重复条目(如果两者用于同一术语)

• #8735: LaTeX: wrong internal links in pdf to captioned code-blocks when numfig is not True

• #8442: LaTeX：使用Xelatex引擎时忽略某些索引项(或pdflatex和 latex_use_xindy 设置为 True )与回忆录课程

• #8750: LaTeX：如果URL源自函数类型签名内部，则作为脚注的URL无法在PDF中显示

• #8780: LaTeX：窄列中的长词不能连字符

• #8788: LaTeX： \titleformat Sphinx.tie中的最后一个参数应该用括号括起来，而不是花括号(而且无论如何也不需要)

• #8849: LaTeX：页边空白处打印的代码块(请参阅Opt-in LaTeX语法布尔 verbatimforcewraps 以通过 'sphinxsetup' 的关键字 latex_elements )

• #8183: LaTeX：仅在LaTeX构建上从doctree中删除substitution_ference节点

• #8865: LaTeX：仅在LaTeX构建时重新构造标题节点内的索引节点

• #8796: LaTeX：到目前为止，尚未注意到潜在的严重低级TeX编码错误

• C、 c:alias 跳过没有显式声明的符号，而不是崩溃。

• C、 c:alias 当根符号未声明时发出警告。

• C、 expr 角色应在当前作用域中启动符号查找。

版本3.4.3(2021年1月8日发布)

修复错误

• #8655: autodoc: Failed to generate document if target module contains an object that raises an exception on hasattr()

版本3.4.2(2021年1月4日发布)

修复错误

• #8164: AutoDoc：未记录继承模拟类的类

• #8602: AutoDoc：The autodoc-process-docstring 事件意外地发出到非datadescriptor

• #8616: AutoDoc：在将非类对象传递给AutoClass指令时引发AttributeError

版本3.4.1(2020年12月25日发布)

修复错误

• #8559: AutoDoc：使用前向引用类型批注时引发AttributeError

• #8568: AutoDoc：检查插槽属性时引发TypeError

• #8567: AutoDoc：实例属性被错误地添加到父类

• #8566: AutoDoc：The autodoc-process-docstring 事件意外地发出到别名类

• #8583: AUTODOC：不必要的对象比较通过 __eq__ 方法

• #8565: 链接检查：修复链接元组不可比较时的PriorityQueue崩溃

版本3.4.0(2020年12月20日发布)

不兼容的更改

• #8105: AutoDoc：类构造函数的签名将为已修饰的类显示，而不是修饰符的签名

已弃用

• 这个 follow_wrapped 论证 sphinx.util.inspect.signature()

• 这个 no_docstring 论证 sphinx.ext.autodoc.Documenter.add_content()

• sphinx.ext.autodoc.Documenter.get_object_members()

• sphinx.ext.autodoc.DataDeclarationDocumenter

• sphinx.ext.autodoc.GenericAliasDocumenter

• sphinx.ext.autodoc.InstanceAttributeDocumenter

• sphinx.ext.autodoc.SlotsAttributeDocumenter

• sphinx.ext.autodoc.TypeVarDocumenter

• sphinx.ext.autodoc.importer._getannotations()

• sphinx.ext.autodoc.importer._getmro()

• sphinx.pycode.ModuleAnalyzer.parse()

• sphinx.util.osutil.movefile()

• sphinx.util.requests.is_ssl_error()

新增特征

• #8119: AutoDoc：允许确定成员是否未包括在 __all__ 模块的属性是否应通过以下方式记录 autodoc-skip-member 活动

• #8219: AUTODOC：当超类是泛型类并且给出了显示继承选项时，不显示泛型类的参数(在Python3.7或更高版本中)

• 自动对接：添加 Documenter.config 作为访问配置对象的快捷方式

• AUTODOG：添加 Optional[t] 如果缺省值等于 None 已经设置好了。

• #8209: AUTODOG：添加 :no-value: 选项以 autoattribute 和 autodata 指令取消变量的缺省值

• #8460: AutoDoc：支持由Typeing.NewType定义的自定义类型

• #8285: 拿破仑：加法 napoleon_attr_annotations 如果在文档字符串中指定了任何类型，则自动合并源代码上的类型提示

• #8236: 拿破仑：支持NUMPYDOC的“接收”栏目

• #6914: 添加新事件 warn-missing-reference 在无法解析交叉引用时自定义警告消息

• #6914: 在无法解析 :ref: 参考文献

• #6629: 链接检查：构建器现在处理速率限制。看见 linkcheck_rate_limit_timeout 了解更多细节。

修复错误

• #7613: AUTODOC：AUTODOC不尊重 __signature__ 班上的

• #4606: AutoDoc：对于继承的方法，警告的位置不正确

• #8105: AutoDoc：如果类是修饰的，则类构造函数的签名不正确

• #8434: AutoDoc： autodoc_type_aliases 不影响变量和属性

• #8443: AutoDoc：AutoData指令无法为基于PEP-526的类型批注变量创建文档

• #8443: AUTODOC：AUTOATIBUTE指令无法为基于PEP-526的未初始化变量创建文档

• #8480: AUTODOC：AUTOATOR无法为其创建文档 __slots__ 属性

• #8503: AutoDoc：AutoAttribute无法将GenericAlias作为类属性正确创建文档

• #8534: AutoDoc：AutoAttribute无法为别名类中的注释属性创建文档

• #8452: 当AUTODOC_TYPEHINTS设置为“DESCRIPTION”时，AUTODOC：AUTODOC_TYPE_ALIASS无效

• #8541: AUTODOC：AUTODOC_TYPE_ALIASES不适用于实例属性的类型批注

• #8460: AutoDoc：AutoData和AutoAttribute指令不显示TypeVars的类型信息

• #8493: AutoDoc：对在类别名中不起作用的内置的引用

• #8522: AutoDoc： __bool__ 方法可以被调用

• #8067: AutoDoc：不显示超类上具有TYPE_COMMENT的实例变量的类型提示

• #8545: AUTODOC：A __slots__ 即使具有文档字符串，也未记录属性

• #741: AutoDoc：继承的成员不适用于超类上的实例属性

• #8477: 自动摘要：当模板包含多字节字符时生成非utf-8 REST文件

• #8501: 自动摘要：摘要提取在“el at”之后拆分文本。出乎意料的

• #8524: Html：在名为“index”的文档上生成了错误的url_root

• #8419: HTMLSearch：不加载 language_data.js 在非搜索页面中

• #8549: I18N： -D gettext_compact=0 已经不再工作了

• #8454: Graph viz：graph和digraph指令的布局选项不起作用

• #8131: 链接检查：当Head请求导致太多重定向时使用GET，以适应Head上的无限重定向循环

• #8437: 生成文件： make clean 车身空空如也很危险

• #8365: PY域： :type: 和 :rtype: 给出错误的歧义类查找警告

• #8352: 标准域：无法分析以方括号开头的选项

• #8519: Latex ：防止纸页在中间刹车

• #8520: C、修复AliasNode的复制。

版本3.3.1(2020年11月12日发布)

修复错误

• #8372: AUTODOC：AUTOCLASS指令比Sphinx 3.2更慢

• #7727: 自动摘要：在不包含以下内容的情况下记录Python包时引发PycodeError __init__. Py

• #8350: 自动汇总：AUTOSTUMALY_MOCK_IMPORTS导致生成速度减慢

• #8364: C、正确初始化空符号中的属性。

• #8399: I18N：将系统区域设置路径放在配置指定的路径之后

3.3.0版（2020年11月2日发布）

已弃用

• sphinx.builders.latex.LaTeXBuilder.usepackages

• sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref

• sphinx.ext.autodoc.SingledispatchFunctionDocumenter

• sphinx.ext.autodoc.SingledispatchMethodDocumenter

新增特征

• #8100: Html：显示复制html_静态_文件失败的更好的错误消息

• #8141: C：添加了 maxdepth 选项以 c:alias 若要插入嵌套声明，请执行以下操作。

• #8081: LaTeX：允许通过以下方式添加LaTeX包装 app.add_latex_package() 直到写入.tex文件之前

• #7996: 手册页：添加 man_make_section_directory 在生成手册页上创建部分目录

• #8289: EPub：允许使用隐藏来自epub构建器的“Duplated TOC Entry Found”警告 suppress_warnings 。

• #8298: Sphinx-快速入门：添加 sphinx-quickstart --no-sep 选择权

• #8304: 测试：在sphinx.testing.fix中注册公共标记

• #8051: 拿破仑：对所有项目使用obj角色参见

• #8050: 拿破仑：申请 napoleon_preprocess_types 到每一个领域

• C和C++，在检测到重复时显示先前声明的行号。

• #8183: 仅在LaTeX版本上从doctree中删除substitution_ference节点

修复错误

• #8085: I18N：添加对单文本域的支持

• #6640: I18N：无法覆盖系统消息转换

• #8143: autodoc: AttributeError is raised when False value is passed to autodoc_default_options

• #8103: AutoDoc：函数工具.缓存_属性不被视为属性

• #8190: AutoDoc：如果某个扩展将文档字符串替换为不以空行结尾的字符串，则会引发分析错误

• #8142: AutoDoc：从类型派生的类的构造函数签名错误。泛型

• #8157: AutoDoc：批注无效时引发TypeError __args__

• #7964: AutoDoc：缺省值中的元组呈现错误

• #8200: AutoDoc：类型别名自动属性的中断类型格式

• #7786: AutoDoc：无法检测在其他文件中定义的重载方法

• #8294: 自动对接：单字符串 __slots__ 未正确处理

• #7785: AUTODOC：AUTODOC_TYPEHINTS=‘NONE’对重载函数不起作用

• #8192: 拿破仑：描述在包含内联文字时消失

• #8142: 拿破仑：Google风格文档中的正则表达式拒绝服务的可能性

• #8169: LaTeX：即使当LaTeX_ENGINE不是Platex时，也会加载pxjahyper

• #8215: LaTeX：‘one side’类选项导致生成警告

• #8175: Intersphinx：中断库存导致正则表达式拒绝服务的可能性

• #8277: Sphinx-Build：构建时控制台输出缺少和多余的空格(等)

• #7973: ImgConverter：多次检查Imagemagick的可用性

• #8255: PY DOMAIN：默认参数值中的数字从十六进制更改为十进制

• #8316: Html：当按钮元素被聚焦时防止箭头键更改页面

• #8343: HTML搜索：修复解析文档时不必要的图像加载

• #8254: HTML主题：行号与代码行不对齐

• #8093: 突出显示警告在某些构建器(LaTeX、Singlehtml等)中的位置错误

• #8215: 消除单面文档的Fancyhdr生成警告

• #8239: 如果是缩进的，则无法在ProductionList中引用令牌

• #8268: linkcheck: Report HTTP errors when linkcheck_anchors is True

• #8245: 链接检查：将本地文件的源目录考虑在内

• #8321: 链接检查： tel: 架构超链接被检测为错误

• #8323: LinkCheck：找到不支持架构的链接时，退出状态不正确

• #8188: C、将缺失的条目添加到内部对象类型词典，例如，阻止Intersphinx解析它们。

• C、 在脊椎间固定一个物体。

• #8270 <https://github.com/sphinx-doc/sphinx/issues/8270> _，C++，如果已经存在同名的非函数声明，则正确地将函数作为重复声明拒绝。

• C、 修复对函数参数的引用。链接到函数而不是不存在的锚点。

• #6914: 图形编号意外地分配给未加标题的项目

• #8320: 使“内联”行号不可选

测试

• #8257: 支持在sphinx中进行并行构建。测试

3.2.1版（2020年8月14日发布）

新增特征

• #8095: 拿破仑：加法 napoleon_preprocess_types 为NumPy样式文档字符串启用类型预处理器

• #8114: C和C++，在参数和限定符之后解析函数属性。

修复错误

• #8074: 拿破仑：在处理C-ext模块时崩溃

• #8088: 拿破仑：在Numpy Style参数部分中出现“Inline Documal Start-Strong Without End-Strong”警告

• #8084: AutoDoc：在记录损坏类的属性时引发KeyError

• #8091: AutoDoc：在记录Python 3.5.2上的属性时引发AttributeError

• #8099: autodoc: NameError is raised when target code uses TYPE_CHECKING

• C++，修复了模板模板参数的解析，修复了 #7944

3.2.0版（2020年8月8日发布）

已弃用

• sphinx.ext.autodoc.members_set_option()

• sphinx.ext.autodoc.merge_special_members_option()

• sphinx.writers.texinfo.TexinfoWriter.desc

• C、解析v3之前的样式类型指令和角色，以及选项 c_allow_pre_v3 和 c_warn_on_allowed_pre_v3 。

新增特征

• #2076: AutoDoc：允许在跳过成员函数中重写排除成员

• #8034: AutoDoc： :private-member: 可以获取要记录的成员名称的显式列表

• #2024: 自动汇总：添加 autosummary_filename_map 避免大小写不同的两个对象之间的文件名冲突

• #8011: 自动汇总：支持实例属性作为自动汇总指令的目标

• #7849: 超文本标记语言：添加 html_codeblock_linenos_style 更改代码块的行号样式的步骤

• #7853: C和C++支持参数化的GNU样式属性。

• #7888: 拿破仑：添加别名，警告和提高。

• #7690: napoleon: parse type strings and make them hyperlinks as possible. The conversion rule can be updated via napoleon_type_aliases

• #8049: napoleon: Create a hyperlink for each the type of parameter when napoleon_use_param is False

• C、 已添加 c:alias 用于插入现有声明副本的指令。

• #7745: Html：如果文档名包含空格，则库存中断

• #7991: Html搜索：允许搜索数字

• #7902: 超文本标记语言主题：添加新选项 globaltoc_maxdepth 在侧边栏中控制global altoc的行为

• #7840: I18N：优化引导上的依赖项检查

• #7768: I18N： figure_language_filename 支座 docpath 令牌

• #5208: 链接检查：本地链接的支持检查

• #5090: SetupTools：将详细信息链接到distutils的-v和-q选项

• #6698: 文档测试：添加 :trim-doctest-flags: 和 :no-trim-doctest-flags: 用于停靠测试、测试代码和测试输出指令的选项

• #7052: 添加 :noindexentry: 添加到Python域、C域、C++域和Java脚本域。更新文档以更好地反映此选项与 :noindex: 选择。

• #7899: C、添加解析一些v3之前风格类型的指令和角色的可能性，并尝试将它们转换为等价的v3指令/角色。设置新选项 c_allow_pre_v3 至 True 来实现这一点。通过设置此功能可以取消从该功能打印的警告 c_warn_on_allowed_pre_v3 至 True 。该功能立即被弃用。

• #7999: C，添加对命名可变宏参数的支持。

• #8071: 允许抑制“自引用目录树”警告

修复错误

• #7886: AutoDoc：在模拟泛型类型的类时引发TypeError

• #7935: AutoDoc：当函数的参数具有 inspect._empty 作为其缺省值

• #7901: AutoDoc：未解析重载函数的类型批注

• #904: AutoDoc：实例属性导致AutoFunction指令崩溃

• #1362: AutoDoc： private-members 选项不适用于类属性

• #7983: AutoDoc：在py36中错误地呈现了生成器类型批注

• #8030: AutoDoc：未初始化的带注释的实例变量在以下情况下不会被记录 :inherited-members: 给出的选项

• #8032: AutoDoc：在父类中定义的实例变量的类型提示未显示在派生类的文档中

• #8041: AutoDoc：当派生类具有其他带注释的实例变量时，不会记录超类上的带注释的实例变量

• #7839: 自动汇总：无法处理函数名中的变音

• #7865: 自动汇总：找到缩写时无法提取汇总行

• #7866: 自动摘要：当文档字符串包含超链接目标时，无法提取正确的摘要行

• #7469: 自动汇总：“模块属性”标头不可翻译

• #7940: Apidoc：如果模块有子模块，则在rst文件的末尾生成额外的换行符

• #4258: 拿破仑：没有展示装饰的特殊方法

• #7799: 拿破仑：NumpyDoc中组合参数的参数不会转义

• #7780: napoleon: multiple parameters declaration in numpydoc was wrongly recognized when napoleon_use_param=True

• #7715: LaTeX： numfig_secnum_depth > 1 导致错误的图形链接

• #7846: HTML主题：XML-生成的文件无效

• #7894: GetText：使用rst_epilog时显示错误的源信息

• #7691: LinkCheck：Head请求不用于检查

• #4888: I18N：无法将显式标题添加到 :ref: 翻译中的角色

• #7928: PY域：无法解析属性的类型批注

• #8008: PY域：无法分析包含省略号的类型批注

• #7994: 标准域：OPTION指令不生成与2.x或更早版本兼容的旧节点ID

• #7968: I18N：的内容 math 指令被解释为翻译时的REST

• #7768: I18N：The root 元素，用于 figure_language_filename 不是用户在文档中指定的路径

• #7993: Tex Info：嵌套对象描述引发TypeError

• #7993: 文本信息：显示不支持desc_sign_line节点的警告

• #7869: abbr 没有解释的角色将显示前一个缩写角色的解释

• #8048: Graph viz：在生成非HTML文档时复制了graph viz.css

• 删除C和C++ noindex 指令选项，因为它什么也没做。

• #7619: 如果节点具有多个ID，则会生成重复的节点ID

• #2050: 符号部分在索引页中出现两次

• #8017: 修复sphinx.addnode中的循环导入

• #7986: Css：使“高亮显示”选择器更加健壮

• #7944: C++中，解析以依赖限定名开头的非类型模板参数。

• C、 不要在每次处理枚举器时都深度复制整个符号表并使其混乱。

3.1.2版（2020年7月5日发布）

不兼容的更改

• #7650: AutoDoc：装饰后的函数会显示基函数签名，而不是修饰符的签名

修复错误

• #7844: AUTODOG：在给定相对模块名称时检测模块失败

• #7856: AutoDoc：当为AutoClass指令提供非类对象时引发AttributeError

• #7850: 当AutoDoc_typehints为‘Description’时，由于无效标记而引发KeyError

• #7812: AutoDoc：如果目标名称与同名的属性和模块匹配，则崩溃

• #7650: AutoDoc：功能签名成为 (*args, **kwargs) 如果函数是由泛型修饰器修饰的

• #7812: 自动汇总：如果目标代码包含同名的属性和模块，则生成损坏的存根文件

• #7806: 视图代码：无法解析第三方生成器上的视图代码引用

• #7838: 超文本标记语言主题：列表项有额外的垂直空间

• #7878: 超文本标记语言主题：“溢出”和“浮动”之间不需要的交互

3.1.1版（2020年6月14日发布）

不兼容的更改

• #7808: 拿破仑：属性的类型表示为类型化字段

新增特征

• #7807: AUTODOC：当TYPE_COMMENT与其签名不匹配时显示详细警告

修复错误

• #7808: AutoDoc：变量和属性类型批注引发警告

• #7802: AutoDoc：并行构建时引发EOFError

• #7821: AutoDoc：对于重载的C-ext函数引发TypeError

• #7805: AutoDoc：描述符返回的对象意外地被记录

• #7807: AutoDoc：使用上下文管理器的函数显示了错误的签名

• #7812: 自动汇总：如果目标代码包含同名的属性和模块，则生成损坏的存根文件

• #7808: 拿破仑：对变量和属性类型批注发出警告

• #7811: Sphinx.util.check导致循环导入问题

3.1.0版（2020年6月8日发布）

依赖关系

• #7746: Mathjax：更新到2.7.5

不兼容的更改

• #7477: ImgConverter：Windows默认调用“Magick Convert”命令

已弃用

• 第一个论点sphinx.ext.自动摘要.生成.AutosummaryRenderer已更改为Sphinx对象

• sphinx.ext.autosummary.generate.AutosummaryRenderer 以对象类型作为参数

• 这个 ignore 的参数 sphinx.ext.autodoc.Documenter.get_doc()

• 这个 template_dir 的参数 sphinx.ext.autosummary.generate. AutosummaryRenderer

• 这个 module 的参数 sphinx.ext.autosummary.generate. find_autosummary_in_docstring()

• 这个 builder 的参数 sphinx.ext.autosummary.generate. generate_autosummary_docs()

• 这个 template_dir 的参数 sphinx.ext.autosummary.generate. generate_autosummary_docs()

• 这个 ignore 的参数 sphinx.util.docstring.prepare_docstring()

• sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()

• sphinx.util.rpartition()

新增特征

• Latex ：使 toplevel_sectioning 在 Latex 主题中设置可选

• Latex ：允许覆盖 Latex 主题的纸张大小和点大小

• Latex ：添加 latex_theme_options 覆盖主题选项

• #7410: Allow to suppress "circular toctree references detected" warnings using suppress_warnings

• C、 添加了范围控制指令， c:namespace ， c:namespace-push 和 c:namespace-pop .

• #2044: AutoDoc：隐藏实例属性的默认值

• #7473: AutoDoc：如果文档字符串包含，则认为成员为公共成员 :meta public: 在信息字段列表中

• #7487: AutoDoc：允许通过py：AutoFunction生成单派发函数的单据

• #7143: AutoDoc：支持最终类和方法

• #7384: AutoDoc：支持由定义的签名 __new__() 、元类和内置基类

• #2106: AutoDoc：支持文档字符串上的多个签名

• #4422: AutoDoc：在Python3.7或更高版本中支持GenericAlias

• #3610: AutoDoc：支持重载函数

• #7722: AutoDoc：支持类型变量

• #7466: 自动摘要：不翻译生成的文档中的标题

• #7490: 自动汇总：添加 :caption: 自动摘要指令的选项，用于设置目录树的标题

• #7469: 自动汇总：支持模块属性

• #248, #6040: 自动汇总：添加 :recursive: 自动汇总指令的选项，用于递归生成存根文件

• #4030: 自动汇总：添加 autosummary_context 为自定义模板添加模板变量

• #7530: Html：支持嵌套的<kbd>元素

• #7481: HTML主题：在脚注/引文标签中添加右页边距

• #7482, #7717: HTML主题：带有标题和行号的代码块的CSS间距

• #7443: 超文本标记语言主题：添加新选项 globaltoc_collapse 和 globaltoc_includehidden 在侧边栏中控制global altoc的行为

• #7484: Html主题：避免侧边栏和其他块之间的冲突

• #7476: HTML主题：Relbar badcrumb应包含当前页面

• #7506: HTML主题：规范的URL不会转义

• #7533: HTML主题：避免genindex.html开头的空格

• #7541: Html主题：在“Body”的末尾增加一个“Clear”

• #7542: HTML主题：使警告/主题/侧边栏可滚动

• #7543: HTML主题：在表格中添加上边距和下边距

• #7695: 超文本标记语言主题：为基本主题添加视区元标签

• #7721: HTML主题：经典：默认代码文本颜色/代码颜色不覆盖Pygments

• C和C++：在声明结束时允许分号。

• C++，解析参数化的NOR，除了说明符之外。

• #7294: C++，用用户定义的文字解析表达式。

• C++，解析尾随返回类型。

• #7143: PY域：添加 :final: 选项以 py:class ， py:exception 和 py:method 指令

• #7596: PY域：将变量的类型批注更改为超链接

• #7770: std domain: option directive support arguments in the form of foo[=bar]

• #7582: 拿破仑：属性的类型表示方式类似于类型注释

• #7734: 拿破仑：属性上的过度转义尾部下划线

• #7247: 链接检查：添加 linkcheck_request_headers 发送特定主机的自定义HTTP标头

• #7792: 设置工具：支持 --verbosity 选择权

• #7683: 增列 allowed_exceptions 参数设置为 Sphinx.emit() 允许处理程序引发指定的异常

• #7295: C++，解析(尾部)需要子句。

修复错误

• #6703: AutoDoc：增量生成不适用于导入的对象

• #7564: AutoDoc：不显示描述符的标注

• #6588: AutoDoc：修饰的继承方法没有文档

• #7469: AUTODOC：变量的AUTODOC-PROCESS-DOCSTRING更改意外缓存

• #7559: AUTODOC：错误检测到同步功能为异步

• #6857: AutoDoc：未能在Enum类上检测到类方法

• #7562: AutoDoc：包含空格的类型提示错误地呈现在 autodoc_typehints ='description' 模式

• #7551: AutoDoc：无法导入嵌套类

• #7362: AutoDoc：不为内置函数呈现正确的签名

• #7654: autodoc: Optional[Union[foo, bar]] is presented as Union[foo, bar, None]

• #7629: AutoDoc：如果指定了无效对象，则AutoFunction会发出不友好的警告

• #7650: AutoDoc：显示修饰函数的未修饰签名

• #7676: AUTODOC：在AUTODOC_MEMBER_ORDER的缺省值中输入错误

• #7676: AUTODOC：错误的值：MEMBER-ORDER：选项被静默忽略

• #7676: AUTODOC：MEMBER-ORDER=“BYSOURCE”不适用于C模块

• #3673: autodoc: member-order="bysource" does not work for a module having __all__

• #7668: 自动对接：错误的返回值被传递给自动对接处理签名的处理程序

• #7711: AutoDoc：处理NumPy对象时失败，返回ValueError

• #7791: AutoDoc：记录单派发函数时引发TypeError

• #7551: 自动汇总：嵌套类被索引为非嵌套类

• #7661: 自动汇总：如果导入目标模块失败，自动汇总指令将发出两次警告

• #7685: autosummary: The template variable "members" contains imported members even if autossummary_imported_members is False

• #7671: 自动摘要：缺少导入失败警告的位置

• #7535: Sphinx-Autogen：当自定义模板使用继承时崩溃

• #7536: Sphinx-Autogen：模板使用I18N功能时崩溃

• #7781: Sphinx-Build：当outdir不是目录时出现错误消息

• #7653: Sphinx-QuickStart：修复嵌套relpath的多个目录创建

• #2785: HTML：公式链接的对齐方式不正确

• #7718: Html主题：一些主题不尊重俾格斯山风格的背景颜色(agogo、haiku、自然、金字塔、卷轴、Sphinx和传统)

• #7544: Html主题：警告中的填充不一致

• #7581: 拿破仑：属性文档字符串中的内联代码解析错误

• #7628: ImgConverter：运行Imagemagick一次，对于不支持图像的构建器不必要

• #7610: 错误地呈现Docutils 0.16的连续反斜杠

• #7646: 处理事件处理程序上的错误

• #4187: LaTeX：连字符从日文文档的PDF书签中消失

• #7701: LaTeX：匿名间接超链接目标导致标签重复

• #7723: 当URL包含单引号时，LaTeX：pdflatex崩溃

• #7756: PY属性域：不显示仅位置参数的默认值

• #7760: 覆盖范围：添加 coverage_show_missing_items 向控制台显示覆盖结果

• C++，在全局范围内显式地启动嵌套名称中的修复渲染和XReFS，例如 ::A::B .

• C、 修复在全局范围内显式开始的嵌套名称中的呈现和外部参照，例如。， .A.B .

• #7763: C和C++，在一元表达式和折叠表达式的显示字符串期间不会崩溃。

3.0.4版（2020年5月27日发布）

修复错误

• #7567: AutoDoc：对于泛型类型，参数化类型显示两次

• #7637: AutoDoc：系统定义的TypeVars在Python3.9中显示

• #7696: 超文本标记语言：出于安全考虑，jQuery版本从3.4.1更新到3.5.1

• #7611: 启用OpenSSL FIPS时，MD5会失败

• #7626: release package does not contain CODE_OF_CONDUCT

3.0.3版（2020年4月26日发布）

新增特征

• C、 使用静态、限定符和VLA规范解析数组声明符。

修复错误

• #7516: AutoDoc：如果目标对象在访问其属性时引发错误，则会崩溃

3.0.2版（2020年4月19日发布）

新增特征

• C、 分析属性并添加 c_id_attributes 和 c_paren_attributes 以支持用户定义的属性。

修复错误

• #7461: PY域：类型批注中的空元组失败，返回IndexError

• #7510: PY属性域：文档中仅包含关键字的参数的默认设置为NONE

• #7418: 标准域名： term 角色不区分大小写

• #7461: AutoDoc：类型批注中的空元组未正确显示

• #7479: AutoDoc：Sphinx版本从3.0.0开始在模仿方面变慢了

• C++，在东东声明中固定间隔问题。

• #7414: LaTeX：新迪语言选项不正确

• 在python3.5.1上，Sphinx崩溃并出现ImportError

3.0.1版（2020年4月11日发布）

不兼容的更改

• #7418: 标准域名： term 角色变得区分大小写

修复错误

• #7428: PY域：对类的引用 None 发出挑剔的警告

• #7445: PY域：一个返回注解 None 在函数中使用intersphinx时，签名不会转换为超链接

• #7418: 标准域：术语表术语的重复警告不区分大小写

• #7438: C++，修复了在并行构建中合并重载函数的问题。

• #7422: AUTODOC：使用AUTODOC_MOCK_IMPORTS时失败，返回ValueError

• #7435: AutoDoc： autodoc_typehints ='description' 不隐藏类/方法的签名中的类型提示

• #7451: AutoDoc：当对象将非字符串对象作为 __doc__ 成员

• #7423: 将非字符串对象提供给记录器时崩溃

• #7479: HTML主题：不要在HTML5文档类型中包含xmlns属性

• #7426: Html主题：转义Html模板中的某些链接

3.0.0版（2020年4月6日发布）

依赖关系

3.0.0b1

• LaTeX：放弃对 extractbb 对于包含在日文文档中的图像， .xbb 以下项目不需要文件 dvipdfmx 自TeXLive2015年以来(参考： #6189 )

• 提供babel-2.0或更高版本（未固定）

不兼容的更改

3.0.0b1

• 删除1.8.x中不推荐使用的功能和API

• #247: 自动汇总：默认情况下会自动覆盖存根文件。看见 autosummary_generate_overwrite 更改行为的步骤

• #5923: AutoDoc：成员 object 默认情况下，在以下情况下不记录类 :inherited-members: 和 :special-members: 都被给予了。

• #6830: PY域： meta INFO-FIELD-LIST中的字段变为保留。它们现在不会显示在输出文档上

• #6417: PY域：desc_参数列表的文档树已更改。参数名称、批注和缺省值用内联节点包装

• 的结构 sphinx.events.EventManager.listeners 已经改变

• 由于范围的变化 productionlist 某些用途 token 必须修改以包含以前忽略的作用域。

• #6903: Python、REST和标准域的内部数据结构发生了变化。将node_id添加到对象和模块的索引中。现在，它们包含一对供交叉引用的docname和node_id。

• #7276: C++ domain: Non intended behavior is removed such as say_hello_ links to .. cpp:function:: say_hello()

• #7210: js domain: Non intended behavior is removed such as parseInt_ links to .. js:function:: parseInt

• #7229: rst domain: Non intended behavior is removed such as numref_ links to .. rst:role:: numref

• #6903: py domain: Non intended behavior is removed such as say_hello_ links to .. py:function:: say_hello()

• #7246: PY域：删除异常、函数和方法的特殊交叉引用帮助器

• C域已被重写，并带有额外的指令和角色。现有的更严格，导致新的警告。

• 属性 sphinx_cpp_tagname 在 desc_signature_line 节点已重命名为 sphinx_line_type .

• #6462: 默认情况下，域指令中的双反斜杠不再替换为单反斜杠。新的配置值 strip_signature_backslash 可以由用户使用以重新启用它。

3.0.0最终版本

• #7222: sphinx.util.inspect.unwrap() is renamed to unwrap_all()

已弃用

3.0.0b1

• desc_signature['first']

• sphinx.directives.DescDirective

• sphinx.domains.std.StandardDomain.add_object()

• sphinx.domains.python.PyDecoratorMixin

• sphinx.ext.autodoc.get_documenters()

• sphinx.ext.autosummary.process_autosummary_toc()

• sphinx.parsers.Parser.app

• sphinx.testing.path.Path.text()

• sphinx.testing.path.Path.bytes()

• sphinx.util.inspect.getargspec()

• sphinx.writers.latex.LaTeXWriter.format_docclass()

新增特征

3.0.0b1

• #247: 自动汇总：添加 autosummary_generate_overwrite 覆盖旧的存根文件

• #5923: AutoDoc： :inherited-members: 选项采用Anchestor类的名称，以不记录继承的类成员和uppers

• #6830: AutoDoc：如果文档字符串包含，则视为私有成员 :meta private: 在信息字段列表中

• #7165: AUTODOC：支持注释类型(PEP-593)

• #2815: AutoDoc：支持单派发函数和方法

• #7079: AutoDoc： autodoc_typehints 接受 "description" 配置。它将类型提示显示为对象描述

• #7314: Apidoc：传播 --maxdepth 通过套餐文档选择

• #6558: 词汇表：对重复的词汇表条目发出警告

• #3106: 域名：自动注册索引页面的超链接目标

• #6558: 标准域：对重复的通用对象发出警告

• #6830: py domain: Add new event: object-description-transform

• #6895: PY域：不要对内置类型发出挑剔的警告

• py域：在函数签名中支持lambda函数

• #6417: PY域：允许为函数和方法的参数设置样式

• #7238, #7239: PY域：如果条目已经以相同的名称添加，则在描述Python对象时发出警告

• #7341: PY域：签名中的类型批注被转换为交叉引用

• 支持事件处理程序的优先级。有关详细信息，请参见 Sphinx.connect()

• #3077: 实施的作用域 productionlist 如文档中所示。

• #1027: 支持中的反斜杠接续 productionlist 。

• #7108: config: Allow to show an error message from conf.py via ConfigError

• #7032: Html： html_scaled_image_link 将对具有以下属性的图像禁用 no-scaled-link 班级

• #7144: 为每个Desc节点添加指示其域的css类

• #7211: LaTeX：使用XeLaTeX时对中文文档使用巴别塔

• #6672: LaTeX：支持LaTeX主题(实验性)

• #7005: LaTeX：添加LaTeX样式宏 kbd 角色

• #7220: Genindex：首先显示主索引项

• #7103: linkcheck: writes all links to output.json

• #7025: HTMLSearch：可以使用以下命令对单个文档禁用全文搜索 :nosearch: 文件范围的元数据

• #7293: html search: Allow to override JavaScript splitter via SearchLanguage.js_splitter_code

• #7142: HTML主题：添加主题选项： pygments_dark_style 在暗模式下切换代码块的样式

• C域已被重写，例如：

  • 与当前范围相关的交叉引用。

  • 可以记录匿名实体。

  • 每种类型实体的更具体的指令和角色，例如，处理枚举数的作用域。

  • 新角色 c:expr 用于在文本中呈现表达式和类型。

• 补充 SphinxDirective.get_source_info() 和 SphinxRole.get_source_info() .

• #7324: Sphinx-Build：如果发现同一文档的多个文件具有不同的文件扩展名，则发出警告

3.0.0最终版本

• 补充 ObjectDescription.transform_content() .

修复错误

3.0.0b1

• C++，在某些涉及函数重载的情况下修复交叉引用查找。

• #5078: C++，修复了指令包含多个声明时的交叉引用查找。

• C++中，在签名中自动生成交叉引用的直接依赖类型名的警告。

• #5637: AutoDoc：在显示继承时不正确地处理嵌套类名称

• #7267: AUTODOC：无效指令选项的错误消息位置错误

• #7329: 从类描述中的类型提示错误地生成了AutoDoc：Info-field-list，即使 autoclass_content='class' 集

• #7331: AutoDoc：cython函数未被识别为函数

• #5637: 继承关系图：不正确地处理嵌套类名称

• #7139: code-block:: guess 不起作用

• #7325: Html：包含点的SOURCE_Suffix指向错误的源链接

• #7357: Html：调整SVG图像大小失败，返回ValueError

• #7278: HTMLSearch：修复使用 html_file_suffix 而不是 html_link_suffix 在搜索结果中

• #7297: html theme: bizstyle does not support sidebarwidth

• #3842: Singlehtml：当master文档不在源根中时，图片的路径被破坏

• #7179: 标准域：修复引用GenericObject上隐藏的空格

• #7289: 控制台：使用鲜艳的颜色，而不是粗体

• #1539: C、解析数组类型。

• #2377: C，即使在复杂类型中也要解析函数指针。

• #7345: Sphinx-Build：如果输出目录以文件形式存在，则Sphinx崩溃

• #7290: Sphinx-Build：在处理异常时忽略bdb.BdbQuit

• #6240: 拿破仑：属性和方法部分忽略：noindex：选项

3.0.0最终版本

• #7364: autosummary: crashed when autosummary_generate is False

• #7370: 自动汇总：在给定未知模块时引发UnundLocalError

• #7367: 现在支持C++、备用运算符拼写。

• C、 现在支持交替运算符拼写。

• #7368: C++、表达式中的逗号运算符、模板参数列表中的包展开，以及在某些情况下更全面的错误消息。

• C、C++，修复与ANON符号相关的崩溃和错误重复警告。

• #6477: 先逃走“！在交叉引用链接中不再可能

• #7219: PY域：由生成的索引项 py:function 指令与的指令不同 index 具有“Builtin”类型的指令

• #7301: Node_id不允许使用大写字符

• #7301: EPub：生成重复的node_id

• #6564: 超文本标记语言：在超文本标记语言生成器上忽略了表宽

• #7401: 为传递的参数不正确 env-get-outdated 处理程序

• #7355: AUTODOC：无法很好地识别cython函数的签名

• #7222: AutoDoc： __wrapped__ 未正确记录函数

• #7409: Intersphinx：在设置扩展时引发ValueError intersphinx_mapping 在……上面 config-inited 活动

• #7343: 在调试模式下，自2.4.0以来，Sphinx的构建速度一直较慢

版本2.4.5(2021年11月18日发布)

依赖关系

• #9807: 将Docutils限制为0.17.x或更早版本

版本2.4.4（2020年3月5日发布）

修复错误

• #7197: LaTeX：Platex导致错误，无法使用目标URL构建映像指令

• #7223: 自2.4.0以来，Sphinx的构建速度一直较慢

版本2.4.3（2020年2月22日发布）

修复错误

• #7184: AutoDoc： *args 和 **kwarg 未正确处理类型中的注释

• #7189: AutoDoc：未检测到类方法协程

• #7183: Sphinx： :attr: 对属性的引用已中断

• #6244, #6387: Html搜索：当使用dirhtml生成器构建时，搜索中断/挂起

• #7195: TODO：使用非文档节点错误地发出doctree解析的事件

版本2.4.2（2020年2月19日发布）

修复错误

• #7138: AutoDoc： autodoc.typehints 当变量将未绑定的对象作为值时崩溃

• #7156: AutoDoc：未显示仅关键字参数的分隔符

• #7146: AUTODOC：发现抑制的TYPE_COMMENT引发IndexError

• #7161: AutoDoc：typehints扩展不支持并行生成

• #7178: AutoDoc：获取类型批注时引发TypeError

• #7151: crashed when extension assigns a value to env.indexentries

• #7170: 文本：删除调试打印

• #7137: View code：避免在给出非python代码时崩溃

版本2.4.1（2020年2月11日发布）

修复错误

• #7120: HTML：缩放具有浮动尺寸的SVG图像时崩溃

• #7126: AutoDoc：TypeError：‘getset_Descriptor’对象不可迭代

版本2.4.0（2020年2月9日发布）

已弃用

• 这个 decode 的参数 sphinx.pycode.ModuleAnalyzer()

• sphinx.directives.other.Index

• sphinx.environment.temp_data['gloss_entries']

• sphinx.environment.BuildEnvironment.indexentries

• sphinx.environment.collectors.indexentries.IndexEntriesCollector

• sphinx.ext.apidoc.INITPY

• sphinx.ext.apidoc.shall_skip()

• sphinx.io.FiletypeNotFoundError

• sphinx.io.get_filetype()

• sphinx.pycode.ModuleAnalyzer.encoding

• sphinx.roles.Index

• sphinx.util.detect_encoding()

• sphinx.util.get_module_source()

• sphinx.util.inspect.Signature

• sphinx.util.inspect.safe_getmembers()

• sphinx.writers.latex.LaTeXTranslator.settings.author

• sphinx.writers.latex.LaTeXTranslator.settings.contentsname

• sphinx.writers.latex.LaTeXTranslator.settings.docclass

• sphinx.writers.latex.LaTeXTranslator.settings.docname

• sphinx.writers.latex.LaTeXTranslator.settings.title

• sphinx.writers.latex.ADDITIONAL_SETTINGS

• sphinx.writers.latex.DEFAULT_SETTINGS

• sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG

• sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG

• sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG

• sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG

新增特征

• #6910: 继承图：使图的背景透明

• #6446: 持续时间：添加 sphinx.ext.durations 检查哪些文档减慢了构建速度

• #6837: LaTeX：支持嵌套表

• #7115: LaTeX：允许通过环境变量覆盖LATEXOPTS和LATEXMKOPTS

• #6966: Graphviz：支持 :class: 选择权

• #6696: Html： :scale: 图像/图形指令选项不适用于SVG图像(需要ImageSize-1.2.0或更高版本)

• #6994: ImgConverter：支持Illustrator文件(.ai)到.png的转换

• autodoc：只支持位置参数分隔符（符合PEP-570）

• autodoc：支持变量的类型注释

• #2755: autodoc: Add new event: autodoc-before-process-signature

• #2755: AutoDoc：支持TYPE_COMMENT样式(例如 # type: (str) -> str )批注(python3.8+或 typed_ast 为必填项)

• #7051: AUTODOC：支持无默认为的实例变量(PEP-526)

• #6418: AutoDoc：添加新的扩展名 sphinx.ext.autodoc.typehints 。如果满足以下条件，则将类型提示显示为对象描述 autodoc_typehints = "description" 准备好了。这是一个实验性的扩展，它将被集成到Sphinx 3.0的AutoDoc核心中

• 如果找不到原始节点类的visitor/department方法，SphinxTranslator现在为超级节点类调用visitor/department方法

• #6418: Add new event: object-description-transform

• py域： py:data 和 py:attribute 接受名为 :type: 和 :value: 描述其类型和初始值

• #6785: PY域： :py:attr: 能够再次引用属性

• #6772: Apidoc：添加 -q 静默模式选项

修复错误

• #6925: Html：从<脚本>元素中删除多余的type=“text/javascript”

• #7112: HTML：即使对齐，SVG图像也不会布局为浮动

• #6906, #6907: AutoDoc：无法读取cp1251中编码的源代码

• #6961: LaTeX：对巴别塔的警告显示两次

• #7059: LaTeX：LaTeX编译陷入无限循环(包装问题)

• #6581: LaTeX： :reversed: Toctree选项不会影响LaTeX构建

• #6559: 词汇表指令中生成了错误的节点ID

• #6986: Apidoc：错误检测模块内.so文件的模块名称

• #6899: Apidoc：不显示私有成员，即使 --private vt.给出

• #6327: Apidoc：支持包含以下内容的一个python包 __init__. SO文件

• #6999: 拿破仑：无法解析：exc：Role中的波浪号

• #7019: GetText：消息目录中使用的绝对路径

• #7023: AutoDoc：未列出嵌套的分部函数

• #7023: AutoDoc：从其他模块导入的部分函数被列为模块成员，但没有：imoprted-Members：选项

• #6889: AutoDoc：尾随逗号 :members:: 选项导致隐晦的警告

• #6568: 自动汇总： autosummary_imported_members 在生成子模块的存根文件时忽略

• #7055: 链接检查：重定向被视为错误

• #7088: HTML模板：If navigation_with_keys 选项处于激活状态时，将忽略修改键，这意味着该要素可能会干扰浏览器要素

• #7090: 标准域：无法为自定义容器节点分配数字编号

• #7106: std domain: enumerated nodes are marked as duplicated when extensions call note_explicit_target()

• #7095: Dirhtml：交叉引用通过intersphinx和 :doc: 角色

• C++：

  • 使用时不要崩溃 struct 在某些情况下扮演角色。

  • 使用时不发出警告 var/member 函数参数的角色。

  • 正确呈现调用和带大括号的init表达式。

• #7097: 由生成的图像的文件名 sphinx.transforms.post_transforms.images.ImageConverter 或者它的子类(用于LaTeX构建)现在被清理，以防止路径中断

版本2.3.1（2019年12月22日发布）

修复错误

• #6936: Sphinx-Autogen：引发属性错误

版本2.3.0（2019年12月15日发布）

不兼容的更改

• #6742: end-before 选项 literalinclude 指令与代码块的第一行不匹配。

• #1331: 将默认用户代理标头更改为 "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: 超文本标记语言：在OpenSearch中使用图标(如果可用)

• #6729: Html主题：Agogo主题现在支持 rightsidebar 选择权

• #6780: 添加PEP-561支持

• #6762: latex: Allow to load additional LaTeX packages via extrapackages key of latex_elements

• #1331: Add new config variable: user_agent

• #6000: Laex：有反斜杠也是行内文字换行字符

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

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

• #6818: 提高多个远程库存的Intersphinx性能。

• #2546: Apidoc：.so文件支持

• #6798: 自动汇总：发射 autodoc-skip-member 生成存根文件时的事件

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

• #6816: 链接检查：添加 linkcheck_auth 用于在执行以下操作时提供身份验证信息的选项 linkcheck 构建

• #6872: 链接检查：处理HTTP 308永久重定向

• #6613: 超文本标记语言：在SPAN标记中换行节号

• #6781: GetText：添加 gettext_last_translator 和 gettext_language_team 自定义POT文件标题的步骤

修复错误

• #6668: LaTeX：表头前的长表距离不正确(参考： latex3/latex2e`#173 `_)

• #6618: LaTeX：避免在页面末尾使用节名

• #6738: LaTeX：在支持UNICODE的LaTeX引擎上，不要用LaTeX宏替换UNICODE字符：？、§、EUROU、∞、±、→，‣、-、上标和下标数字按原样经过(默认OpenType字体支持它们)

• #6704: Linkcheck：防御性，处理新定义的HTTP错误代码

• #6806: 链接检查：解析内容失败

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

• #6584: I18N：编译印地语消息目录时出错

• #6718: I18N：如果节标题和表标题相同，则引发KeyError

• #6743: I18N： rst_prolog 打破翻译

• #6708: Mathbase：已删除一些不推荐使用的函数

• #6709: AutoDoc：模拟对象不能作为类修饰器工作

• #5070: EPub：错误的内部HREF片段链接

• #6712: 允许不将sphinx.esting作为运行时安装(主要用于alt Linux)

• #6741: html: search result was broken with empty html_file_suffix

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

• #6804: LaTeX：如果危险类型的警告包含足够长的代码块而无法容纳在一页中，则PDF构建中断

• #6809: LaTeX：危险类型警告中的代码块很容易溢出页面底部

• #6793: 文本信息：“侧边栏”后面断开的代码示例

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

• #6850: 修复带有错误选项的Smartyants模块调用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-内部版本： -D 选项不考虑 0 和 1 作为布尔值

版本2.2.2（2019年12月3日发布）

不兼容的更改

• #6803: 出于对PYTHON的安全考虑，在MacOS和PYTHON3.8+上禁用并行模式

修复错误

• #6776: LaTeX: 2019-10-01 LaTeX release breaks sphinxcyrillic.sty

• #6815: I18N：法语、印地语、中文、日语和韩语翻译消息已被破坏

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

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

修复错误

• #6641: LaTeX: Undefined control sequence \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()

• 这个 info 和 warn 论点 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: option is renamed to :layout:

• #1464: 超文本标记语言：在以下情况下发出警告 html_static_path 和 html_extra_path 目录位于输出目录内

• #6514: HTML：添加标签以搜索输入内容，以实现可访问性

• #5602: Apidoc：添加 --templatedir 选择权

• #6475: Add override argument to app.add_autodocumenter()

• #6310: IMGMATH：让 imgmath_use_preview 还可以使用SVG格式进行内联数学图像渲染

• #6533: LaTeX: refactor visit_enumerated_list() to use \sphinxsetlistlabels

• #6628: quickstart: Use https://docs.python.org/3/ for default setting of intersphinx_mapping

• #6419: Sphinx-Build：给出重建的原因

修复错误

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

• #6499: Html：Sphinx从不更新 html_logo 即使原始文件已更改

• #1125: Html主题：在经典主题和MacOS上很难看到滚动条

• #5502: 链接检查：将HTTP 503响应视为不是错误

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

• #6486: 如果安装了损坏的扩展模块，则会引发Unound LocalError

• #6567: autodoc: autodoc_inherit_docstrings does not effect to __init__() and __new__()

• #6574: AutoDoc： autodoc_member_order 在以下情况下不引用进口订单 'bysource' 订单

• #6574: AutoDoc：变量参数和关键字参数缺少类型批注

• #6589: AUTODOC：使用AUTODOC_TYPEHINTS=‘None’设置格式问题

• #6605: AutoDoc：当目标代码包含类似自定义方法的对象时崩溃

• #6498: 自动汇总：使用错误的自动汇总_生成设置崩溃

• #6507: 自动汇总：在没有自动汇总_生成设置的情况下崩溃

• #6511: LaTeX：自Sphinx 1.8.0起，LaTeX中不能自定义自动编号列表(参考： #6533 )

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

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

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

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

• #6549: Sphinx-Build：错误消息中的转义字符

• #6545: 自Sphinx 1.8.0以来，Doctest注释未被删除

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

• #6620: I18N：Docutils 0.15不翻译定义列表的分类符

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

2.1.2版（2019年6月19日发布）

修复错误

• #6497: 自定义词法分析器在语法错误时无法突出显示

• #6478, #6488: 无法正确识别信息字段列表

2.1.1版（2019年6月10日发布）

不兼容的更改

• #6447: AutoDoc：停止为未记录的模块变量生成文档

修复错误

• #6442: LaTeX：告诫 note 类型可以用分页符与前一节标题隔开

• #6448: autodoc: crashed when autodocumenting classes with __slots__ = None

• #6451: AutoDoc：将“可选的导入”ed模块的文档作为变量生成

• #6452: 自动汇总：生成属性文档时崩溃

• #6455: 拿破仑：不处理属性的文档字符串

• #6436: 拿破仑：如果变量名以下划线结尾，则出现“未知目标名称”错误

• #6440: Apidoc：模块之间缺少空行

2.1.0版（2019年6月2日发布）

不兼容的更改

• 忽略没有文件扩展名的文件名 Builder.build_specific() 直接API

• #6230: 如果术语表指令中的术语由非ASCII字符组成，则更改该术语的锚点

• #4550: 超文本标记语言：默认情况下使用CSS使表格居中

• #6239: LaTeX：中文文档默认使用xelatex和xeCJK

• Sphinx.add_lexer() 现在接受Lexer类而不是实例。在Sphinx 3.x之前，仍支持词法分析器的实例。

已弃用

• sphinx.builders.latex.LaTeXBuilder.apply_transforms()

• sphinx.builders._epub_base.EpubBuilder.esc()

• sphinx.directives.Acks

• sphinx.directives.Author

• sphinx.directives.Centered

• sphinx.directives.Class

• sphinx.directives.CodeBlock

• sphinx.directives.Figure

• sphinx.directives.HList

• sphinx.directives.Highlight

• sphinx.directives.Include

• sphinx.directives.Index

• sphinx.directives.LiteralInclude

• sphinx.directives.Meta

• sphinx.directives.Only

• sphinx.directives.SeeAlso

• sphinx.directives.TabularColumns

• sphinx.directives.TocTree

• sphinx.directives.VersionChange

• sphinx.domains.python.PyClassmember

• sphinx.domains.python.PyModulelevel

• sphinx.domains.std.StandardDomain._resolve_citation_xref()

• sphinx.domains.std.StandardDomain.note_citations()

• sphinx.domains.std.StandardDomain.note_citation_refs()

• sphinx.domains.std.StandardDomain.note_labels()

• sphinx.environment.NoUri

• sphinx.ext.apidoc.format_directive()

• sphinx.ext.apidoc.format_heading()

• sphinx.ext.apidoc.makename()

• sphinx.ext.autodoc.importer.MockFinder

• sphinx.ext.autodoc.importer.MockLoader

• sphinx.ext.autodoc.importer.mock()

• sphinx.ext.autosummary.autolink_role()

• sphinx.ext.imgmath.DOC_BODY

• sphinx.ext.imgmath.DOC_BODY_PREVIEW

• sphinx.ext.imgmath.DOC_HEAD

• sphinx.transforms.CitationReferences

• sphinx.transforms.SmartQuotesSkipper

• sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()

• sphinx.util.node.find_source_node()

• sphinx.util.i18n.find_catalog()

• sphinx.util.i18n.find_catalog_files()

• sphinx.util.i18n.find_catalog_source_files()

有关详细信息，请参阅 deprecation APIs list .

新增特征

• 添加助手类 sphinx.transforms.post_transforms.SphinxPostTransform

• 添加助手方法

  • PythonDomain.note_module()

  • PythonDomain.note_object()

  • SphinxDirective.set_source_info()

• #6180: 支持 --keep-going 使用 BuildDoc 设置命令

• math 指令现在支持 :class: 选项

• todo： todo 指令现在支持 :name: 选项

• 通过以下环境启用覆盖 SPHINXOPTS 和 SPHINXBUILD Makefile变量(参考： #6232 ， #6303 )

• #6287: AutoDoc：无法记录作为模块函数导出的绑定实例方法

• #6289: AutoDoc： autodoc_default_options 现在支持 imported-members 选择权

• #4777: AUTODOC：支持协同程序

• #744: AutoDoc：支持抽象方法

• #6325: AutoDoc：支持属性 __slots__. 对于词典样式 __slots__, AutoDoc将值视为属性的文档字符串

• #6361: AUTODOG：添加 autodoc_typehints 隐藏签名中的类型提示

• #1063: AutoDoc： automodule 指令现在可以处理未记录的模块级别变量

• #6212 自动汇总：添加 autosummary_imported_members 在自动汇总上显示导入的成员

• #6271: make clean 如果建造成‘’，就会遭到灾难性的破坏。

• #6363: 支持 %O% Make.bat中的环境变量

• #4777: PY域：添加 :async: 选项以 py:function 指令

• py域：添加新选项到 py:method 指令

  • :abstractmethod:

  • :async:

  • :classmethod:

  • :property:

  • :staticmethod:

• RST域：添加 rst:directive:option 用于描述选项的指令

• #6306: HTML：将标签添加到搜索表单以实现可访问性

• #4390: HTML：用于签名的一致和语义的CSS

• #6358: 这个 rawsource 的属性 production 节点现在包含完整的产生式规则

• #6373: AutosectionLabel：允许隐藏警告

• 覆盖范围：支持新的 coverage_ignore_pyobjects 选项

• #6239: LaTeX：支持构建中文文档

修复错误

• #6230: 如果术语由非ASCII字符组成，则术语表指令生成了不正确的node_id

• #6213: Ifconfig：不显示标题后的内容

• 术语表指令中的注释术语被错误识别

• #6299: Rst域：rst：指令指令生成浪费空间

• #6379: Py域：模块索引(py-modindex.html)有重复的标题

• #6331: MAN：当Doctest跟在题目后面时输出无效

• #6351: 即使被引用，也会显示“Hyperlink Target is Not Referated”消息

• #6165: AutoDoc： tab_width 已忽略Docutils的设置

• #6347: AutoDoc：在Python3.6和3.5上使用纯Tuple崩溃

• #6311: 自动汇总：自动汇总表被复杂类型提示搞混了

• #6350: 自动汇总：对具有某种缺省值的参数感到困惑

• 生成的Makefile缺少最终的EOL(参考： #6232 )

• #6375: Extlink：无法转义链接标题中的尖括号

• #6378: 链接检查：发送常用用户代理

• #6387: 超文本标记语言搜索：无法搜索具有haiku和滚动主题的文档

• #6408: Html搜索：修复搜索结果的排名

• #6406: Wrong year is returned for SOURCE_DATE_EPOCH

• #6402: 图像指令因未知的图像格式而崩溃

• #6286: C++，允许8和9为十六进制整型文字。

• #6305: 修复解析器‘Path’参数的快速入门中的字符串

• LaTeX：警告中的数字产生错误(参考： #6364 )

2.0.1版（2019年4月8日发布）

修复错误

• LaTeX：有些系统标签未翻译

• removedinsfhinx30警告标记为挂起

• 不发出弃用警告

  • sphinx.application.CONFIG_FILENAME

  • sphinx.builders.htmlhelp

  • viewcode_import

• #6208: C++，正确解析碰巧以短外部参照为前缀的完整外部参照

• #6220, #6225: 拿破仑：对于具有引用的凸起部分引发AttributeError

• #6245: 导入SerializingHTMLBuilder时出现循环导入错误

• #6243: LaTeX：忽略LaTeX_ELEMENTS的‘relasename’设置

• #6244: 超文本标记语言：搜索功能因第三方主题而中断

• #6263: HTML5Translator崩溃，字段节点无效

• #6262: Html主题：BizStyle主题中字段列表的样式已更改

2.0.0版（2019年3月29日发布）

依赖关系

2.0.0b1

• Latex builder 现在依赖Tex Live 2015或更高版本。

• Latex builder（带 'pdflatex' latex_engine ）将通过文本字体处理文本（不是数学标记）中的Unicode希腊字母，并且不会将它们转义为数学标记。参见 'fontenc' 关键 latex_elements ；此类（可选）对希腊语的支持，例如在Ubuntu Xenial上， texlive-lang-greek 和（如果未修改默认字体设置） cm-super(-minimal) 作为Sphinx Latex 的附加要求。

• Latex builder latex_engine 设置为 'xelatex' 或 'lualatex' 要求（默认情况下） FreeFont 字体，在Ubuntu Xenial中由软件包提供 fonts-freefont-otf ，例如，在Fedora 29中，通过包裹 texlive-gnu-freefont .

• 请求2.5.0或更高

• 六个包不再是依赖项

• sphinxcontrib websupport包不再是依赖项

• 一些包被分为子包：

  • sphinxcontrib.applehelp

  • sphinxcontrib.devhelp

  • sphinxcontrib.htmlhelp

  • sphinxcontrib.jsmath

  • sphinxcontrib.serializinghtml

  • sphinxcontrib.qthelp

不兼容的更改

2.0.0b1

• 删除python 2.7和3.4支持

• 放弃Docutils 0.11支持

• 删除1.7.x中不推荐使用的功能和API

• 的默认设置 master_doc 已更改为 'index' 它一直被用作Sphinx快速启动的默认值。

• Latex ：将消息资源移动到 sphinxmessage.sty

• Latex：停止使用 \captions<lang> 某些标签的宏

• LaTeX：用于 'xelatex' 和 'lualatex' ，请使用 FreeFont 默认选择的OpenType字体(参考： #5645 )

• LaTeX： 'xelatex' 和 'lualatex' 现在使用 \small 在代码块中(由于 FreeMono 字符宽度)点赞 'pdflatex' 已经这样做了(由于 Courier 字符宽度)。您可能需要通过以下方式调整此设置 latex_elements 'fvset' 键，在使用其他OpenType字体的情况下(参考： #5768 )

• Latex：文本中的希腊字母不会转义为数学模式标记，它们将使用文本字体而不是数学字体。这个 LGR 字体编码必须添加到 'fontenc' 关键 latex_elements 为了使其有效（当然，只有当文档需要时）。

• LaTeX：设置 language 至 'en' 触发式 Sonny 选项 fncychap ，现在是了 Bjarne 匹配未指定语言的大小写。(参考文献： #5772 )

• #5770: Doctest：关注 highlight_language 高亮显示DOCST块。因此，默认情况下，它们会突出显示为python3。

• 的论证顺序 HTMLTranslator ， HTML5Translator 和 ManualPageTranslator 被改变

• Latex ：硬编码重新定义 \l@section 和 \l@subsection 以前在加载期间完成 'manual' docclass稍后执行，时间为 \sphinxtableofcontents . 这意味着来自LaTex前言的自定义用户定义现在会被覆盖。使用 \sphinxtableofcontentshook 插入自定义用户定义。见 宏指令 .

• 快速启动：简化生成的 conf.py

• #4148: 快速入门：删除了一些问题。他们仍然能够通过命令行选项指定

• WebSupport：脱离Sphinx核心。请使用ShinxContrrib-WebSupport

• C++中，基类的可见性现在总是呈现在输入中。也就是说， private 现在显示，以前省略了它。

• LaTeX：即使使用了宽度和/或高度选项，包含超大图像的图形也会重新缩放，以不超过文本的宽度和高度。(参考文献： #5956 )

• EPUB： epub_title 默认为 project 选项

• #4550: 所有表格和插图均不包含 align 选项以居中显示

• #4587: HTML5：默认输出HTML5

2.0.0b2

• texinfo:图像文件被复制到 name-figure 目录

已弃用

2.0.0b1

• 不支持评估python 2语法。这包括应转换为python 3的配置文件。

• 的论点 EpubBuilder.build_mimetype() ， EpubBuilder.build_container() ， EpubBuilder.bulid_content() ， EpubBuilder.build_toc() 和 EpubBuilder.build_epub()

• 的论点 Epub3Builder.build_navigation_doc()

• 配置变量

  • html_experimental_html5_writer

• 这个 encoding 的参数 autodoc.Documenter.get_doc() ， autodoc.DocstringSignatureMixin.get_doc() ， autodoc.DocstringSignatureMixin._find_signature() 和 autodoc.ClassDocumenter.get_doc() 被贬低。

• 这个 importer 的参数 sphinx.ext.autodoc.importer._MockModule

• 这个 nodetype 的参数 sphinx.search.WordCollector. is_meta_keywords()

• 这个 suffix 的参数 env.doc2path() 被贬低。

• 字符串样式 base 的参数 env.doc2path() 被贬低。

• 允许省略 filename 重写的参数 IndexBuilder.feed() 方法已弃用。

• sphinx.addnodes.abbreviation

• sphinx.application.Sphinx._setting_up_extension

• sphinx.builders.epub3.Epub3Builder.validate_config_value()

• sphinx.builders.html.SingleFileHTMLBuilder

• sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()

• sphinx.cmd.quickstart.term_decode()

• sphinx.cmd.quickstart.TERM_ENCODING

• sphinx.config.check_unicode()

• sphinx.config.string_classes

• sphinx.domains.cpp.DefinitionError.description

• sphinx.domains.cpp.NoOldIdError.description

• sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded

• sphinx.ext.autodoc.importer._MockImporter

• sphinx.ext.autosummary.Autosummary.warn()

• sphinx.ext.autosummary.Autosummary.genopt

• sphinx.ext.autosummary.Autosummary.warnings

• sphinx.ext.autosummary.Autosummary.result

• sphinx.ext.doctest.doctest_encode()

• sphinx.io.SphinxBaseFileInput

• sphinx.io.SphinxFileInput.supported

• sphinx.io.SphinxRSTFileInput

• sphinx.registry.SphinxComponentRegistry.add_source_input()

• sphinx.roles.abbr_role()

• sphinx.roles.emph_literal_role()

• sphinx.roles.menusel_role()

• sphinx.roles.index_role()

• sphinx.roles.indexmarkup_role()

• sphinx.testing.util.remove_unicode_literal()

• sphinx.util.attrdict

• sphinx.util.force_decode()

• sphinx.util.get_matching_docs()

• sphinx.util.inspect.Parameter

• sphinx.util.jsonimpl

• sphinx.util.osutil.EEXIST

• sphinx.util.osutil.EINVAL

• sphinx.util.osutil.ENOENT

• sphinx.util.osutil.EPIPE

• sphinx.util.osutil.walk()

• sphinx.util.PeekableIterator

• sphinx.util.pycompat.NoneType

• sphinx.util.pycompat.TextIOWrapper

• sphinx.util.pycompat.UnicodeMixin

• sphinx.util.pycompat.htmlescape

• sphinx.util.pycompat.indent

• sphinx.util.pycompat.sys_encoding

• sphinx.util.pycompat.terminal_safe()

• sphinx.util.pycompat.u

• sphinx.writers.latex.ExtBabel

• sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()

• sphinx.writers.latex.LaTeXTranslator.babel_defmacro()

• sphinx.writers.latex.LaTeXTranslator.collect_footnotes()

• sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()

• sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()

• sphinx.writers.text.TextTranslator._make_depart_admonition()

• Latex 模板的模板变量

  • logo

  • numfig_format

  • pageautorefname

  • translatablestrings

有关详细信息，请参阅 deprecation APIs list .

新增特征

2.0.0b1

• #1618: 生成的HTML文档的搜索结果预览对读者更加友好：Sphinx现在不再将代码片断显示为原始的reStrinredText标记，而是呈现相应的HTML。这意味着Sphinx扩展 Sphinx: pretty search results 已经不再必要了。请注意，对您的自定义或第三方HTML模板的搜索功能进行更改可能会覆盖此改进。

• #4182: autodoc: Support suppress_warnings

• #5533: autodoc: autodoc_default_options supports member-order

• #5394: AutoDoc：在模拟对象的类型批注中显示可读名称

• #5459: AutoDoc： autodoc_default_options 接受 True 作为一种价值

• #1148: AUTODOG：添加 autodecorator 针对装修工的指令

• #5635: 自动汇总：添加 autosummary_mock_imports 在导入目标上模拟外部库

• #4018: htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix

• #5559: 文本：支持复杂表格(colspan和rowspan)

• LaTeX：支持在非西里尔文档中呈现希腊和西里尔Unicode字母(目前还不在数学中)，即使是 'pdflatex' AS latex_engine (参考文献： #5645 )

• #5660: 这个 versionadded ， versionchanged 和 deprecated 指令现在是用它们自己的特定CSS类生成的 (added ， changed 和 deprecated 分别)除了通用的 versionmodified 班级。

• #5841: Apidoc：为sphinx-apidoc添加--扩展选项

• #4981: C++，添加了一个别名指令，用于插入引用现有声明的声明列表(例如，用于制作摘要)。

• C++：添加 cpp:struct 补足 cpp:class .

• #1341 HTML搜索将包含长度为三或更长的搜索词的单词视为匹配。

• #4611: EPub：显示重复目录条目的警告

• #1851: Allow to omit an argument for code-block directive. If omitted, it follows highlight or highlight_language

• #4587: 超文本标记语言：添加 html4_writer 使用旧的HTML4编写器

• #6016: HTML搜索：搜索摘要的占位符可防止搜索结果链接在搜索终止时更改其位置。这使得导航搜索结果变得更容易。

• #5196: 链接检查还会检查远程映像是否存在

• #5924: Githebages：在以下情况下为自定义域名创建CNAME文件 html_baseurl 集

• #4261: autosectionlabel: restrict the labeled sections by new config value; autosectionlabel_maxdepth

修复错误

2.0.0b1

• #1682: LaTeX：作者不应翻译希腊语Unicode，而应使用TextGreek包

• #5247: LaTeX：PDF不是使用俄语和 'xelatex' 或 'lualatex' AS latex_engine (参考文献： #5251 )

• #5248: LaTeX：部分标题中的希腊字母从PDF书签中消失

• #5249: LaTeX：数学指令中的Unicode希腊字母中断PDF版本(修复需要额外设置，请参见 latex_elements 'textgreek' 密钥和/或 latex_engine 设置)

• #5772: LaTeX：如果作为语言选项通过，那么bjarne风格的fncychap是否也应该用于英语？

• #5179: LaTeX：(仅限lualatex)逸出 > 通过 \textgreater{} 是不够的，因为 \textgreater{}\textgreater{} 应用Tex结扎术

• Latex ：如果 latex_documents 省略

• Latex ：如果 latex_documents 省略

• HTML：为一个描述具有多个术语的词汇表生成无效的HTML5文件(参考： #4611 )

• qthelp:os依赖路径分隔符在.qhp文件中使用

• HTML搜索：当使用多个搜索词且一个词短于三个字符时，搜索始终不返回任何内容。

2.0.0b2

• #6096: 超文本标记语言：锚链接不会添加到插图

• #3620: HTML：延迟搜索索引.js，而不是通过AJAX加载它

• #6113: HTML：表格单元格和列表项的页边距较大

• #5508: linenothreshold 选项 highlight 指令被忽略

• 文本信息： make install-info 导致语法错误

• 文本信息： make install-info Mac OS失败

• #3079: texinfo: image files are not copied on make install-info

• #5391: 标题中的交叉引用以文字形式呈现

• #5946: C++，修复 cpp:alias LaTeX(和Singlehtml)中的问题

• #6147: 类别属性 citation_reference 节点丢失

• AssertionError在自定义 citation_reference 具有CLASSES属性的节点引用缺失的引文(参考： #6147 )

• #2155: 支持 code 指令

• C++，对括号初始化器进行固定解析。

• #6172: 对于旧样式的索引节点引发AttributeError

• #4872: 继承图：正确描述的行为 parts 选项，则允许负值。

• #6178: I18N：隐藏目录的翻译中缺少字幕

2.0.0决赛

• #6196: PY域：生成意外的前缀

测试

2.0.0b1

• 停止使用 SPHINX_TEST_TEMPDIR 恩瓦尔

2.0.0b2

• 添加助手函数： sphinx.testing.restructuredtext.parse()

版本1.8.6(2021年11月18日发布)

依赖关系

• #9807: 将Docutils限制为0.17.x或更早版本

1.8.5版（2019年3月10日发布）

修复错误

• LaTeX：删除PDF标题页上作者姓名后的无关空格(参考： #6004 )

• #6026: LaTeX：交叉引用定义列表不起作用

• #6046: LaTeX： TypeError 在给定无效的LaTeX_Elements时引发

• #6067: LaTeX：将具有目标的图像连接到下一行

• #6067: LaTeX：具有目标的图像即使指定也不会对齐

• #6149: LaTeX： :index: 职称原因中的角色 Use of \@icentercr doesn't match its definition 生成latexpdf时出错

• #6019: ImgConverter：包含多页PDF失败

• #6047: AutoDoc： autofunction 对方法对象发出警告

• #6028: Graph viz：确保graph viz文件名是可复制的

• #6068: 文档测试： skipif 选项可能会从文档中删除代码块

• #6136: :name: 选项 math 指令导致崩溃

• #6139: Intersphinx：失败报告中的ValueError

• #6135: 更改：在找到任何模块时修复Unound LocalError

• #3859: 手册页：代码块标题显示不正确

1.8.4版（2019年2月3日发布）

修复错误

• #3707: LaTeX：没有粗体复选标记(✔)。

• #5605: 由于文档语言设置为中文，因此无法搜索英文单词。

• #5889: LaTeX：用户 numfig_format 被剥夺了空间，可能会导致生成失败

• C++，修复涉及东CV限定符的声明的超链接。

• #5755: C++，修复返回类型中具有约束的函数模板上的重复声明错误。

• C++，解析一元右折叠表达式和二进制折叠表达式。

• pycode无法处理Windows上的egg文件

• #5928: KeyError：运行生成时的‘DOCUTILSCONFIG’

• #5936: LaTeX：PDF版本因在警告中包含比页面高度更高的图像而被破坏

• #5231: “make html”不会读取和构建“Locale”目录中的“po”文件。

• #5954: :scale: 图像选项可能在警告中破坏PDF Build If图像

• #5966: 在增量构建中尚未加载Mathjax

• #5960: LaTeX: modified PDF layout since September 2018 TeXLive update of parskip.sty

• #5948: LaTeX：为横断面生成重复标签

• #5958: 添加了版本的指令导致与Python3.5.0的崩溃

• #5995: AUTODOC：AUTODOC_MOCK_IMPORTS与Python3.7上的元类冲突

• #5871: 文本信息：一节标题 . 是不允许的

1.8.3版（2018年12月26日发布）

新增特征

• Latex ：可以在标题页后面插入自定义材料，请参见 'maketitle' 关键 latex_elements ('manual' 只有DOCKET类）

修复错误

• #5725: Mathjax：最新版本默认使用CDN地址

• #5460: 在某些第三方主题中，HTML搜索不起作用

• #5520: LaTeX，字幕包自Sphinx 1.6起不兼容

• #5614: AutoDoc：导入内置模块时，增量构建中断

• #5627: Qthelp：QtHelp中缺少index.html

• #5659: LinkCheck：包含多字节字符的超链接崩溃

• #5754: DOC: Fix some mistakes in Latex 定制

• #5810: LaTeX：sphinxVerbatim从1.6.6开始需要显式的“hlline”设置(参考： #1238 )

• #5636: C++，修复了浮点文字的解析。

• #5496 (再次)：C++，修复带有重复项的部分构建中的断言。

• #5724: 当$LC_ALL为空时，QuickStart：Sphinx-QuickStart失败

• #1956: 默认的conf.py不符合PEP8

• #5849: LaTeX：文档类 \maketitle 被覆盖，不可能使用原始含义取代Sphinx自定义含义

• #5834: apidoc: wrong help for --tocfile

• #5800: TODO：如果在TextElement中定义了TODO，则崩溃

• #5846: HtmlHelp：在.hhc/.hhk文件中将十六进制转义转换为十进制转义

• htmlhelp:当标题包含双引号时生成的.hhk文件已中断

1.8.2版（2018年11月11日发布）

不兼容的更改

• #5497: 除非确实需要，否则不要包含MathJax.js和jsmath.js

新增特征

• #5471: 显示适当的弃用警告

修复错误

• #5490: LaTeX：枚举列表导致带有RECONOMARK的崩溃

• #5492: Sphinx-Build无法使用低于3.5.2的版本构建文档

• #3704: LaTeX：错了 \label 带有图例的人物的定位

• #5496: C++，修复一个符号声明两次以上时的断言。

• #5493: GetText：因模板损坏而崩溃

• #5495: 包含文件中带有文件选项的CSV-TABLE指令中断(参考： #4821 )

• #5498: autodoc: unable to find type hints for a functools.partial

• #5480: AutoDoc：找不到无法解析的正向引用的类型提示

• #5419: 已生成不兼容的MATH_BLOCK节点

• #5548: 在已存在文件的情况下修复ensuredir

• #5549: Graphviz可正确处理不存在的静态目录

• #3002: I18N：引用同一脚注的多个Footnote_Reference导致重复的node_id

• #5563: 由扩展生成的LaTeX：Footnote_Reference会导致LaTeX构建器崩溃

• #5561: 使用旧的xindy版本时，make all-pdf失败

• #5557: QuickStart：--不支持批处理文件

• #3080: 文本信息：多行红字已损坏

• #3080: 文本信息：多行引用已中断

1.8.1版（2018年9月22日发布）

不兼容的更改

• Latex \pagestyle 命令已移至LaTeX模板。在PDF中不做任何更改，除非可能出现以下情况 \sphinxtableofcontents ，其中包含它们，它是在 conf.py 。(参考文献： #5455 )

修复错误

• #5418: Sphinx-Build-d/doctree文件的默认路径不正确

• #5421: autodoc emits deprecation warning for autodoc_default_flags

• #5422: Lambda对象导致存储环境上的PicklingError

• #5417: 在Python2.7.5中，Sphinx构建失败，出现语法错误

• #4911: 将latexpdf添加到Make.bat以用于非Make模式

• #5436: AutoDoc不适用于具有属性/方法的枚举子类

• #5437: AutoDoc：在导入鸡蛋的模块上崩溃

• #5433: LaTeX：ImportError：无法导入名称‘DEFAULT_SETTINGS’

• #5431: AutoDoc： autofunction 对可调用对象发出警告

• #5457: 修复禁止覆盖时错误消息中的类型错误

• #5453: “How to”文档的PDF版本没有页码

• #5463: Mathbase：MathRole和MathDirective在1.8.0中消失

• #5454: LaTeX：日文文档的索引已从PDF中消失

• #5432: PY域： :type: 字段无法处理 :term: 参考文献

• #5426: PY域：已为类属性引发TypeError

1.8.0版（2018年9月13日发布）

依赖关系

1.8.0b1

• LaTeX： latex_use_xindy ，如果 True (默认为 xelatex/lualatex )，指示 make latexpdf 使用 xindy 用于一般指数。确保您的LaTeX分发中包含它。(参考文献： #5134 )

• Latex ： latexmk 需要 make latexpdf 在Windows上

不兼容的更改

1.8.0b2

• #5282: 超文本标记语言主题：参考 pygments_style 优先设置Html主题

• 下载文件的URL已更改

• #5127: 快速入门： Makefile 和 make.bat 如果存在，则不会覆盖

1.8.0b1

• #5156: 这个 sphinx.ext.graphviz 扩展运行 dot 在要构建的文档的目录中，而不是在文档的根目录中。

• #4460: 将任何数据存储到环境的扩展应该将其环境数据结构的版本作为元数据返回。具体内容请参阅 扩展元数据 。

• sphinx期望源解析器模块支持的文件格式为 Parser.supported 属性

• 默认值为 epub_author 和 epub_publisher 更改自 'unknown' 的价值 author . 这和A一样 conf.py 文件sphinx生成。

• 这个 gettext_compact 属性已从中删除 document.settings 对象。请使用 config.gettext_compact 相反。

• 读取阶段的处理顺序已更改。智能引用，Sphinx域， doctree-read 事件和版本控制文档的调用时间早于目前。有关详细信息，请阅读 Sphinx.add_transform()

• #4827: 全 substitution_definition 在读取阶段从文档树中删除节点

• docutils.conf 在里面 $HOME 或 /etc 目录被忽略。只有 docutils.conf 从confdir开始。

• #789: :samp: 用反斜杠转义大括号的角色支持

• #4811: 下的文件 html_static_path 从源文件中排除。

• 胶乳：使用 \sphinxcite 作为引文参考 \hyperref

• 配置值 viewcode_import 已重命名为 viewcode_follow_imported_members (参考文献： #4035 )

• #1857: LaTeX： latex_show_pagerefs 不会为引用添加页面标题

• #4648: LaTeX：现在“Qubric”元素呈现为未编号的部分标题

• #4983: Html：ProductionList令牌的锚点已更改

• 修改模板变量 script_files 现在允许在模板中使用。请使用 app.add_js_file() 相反。

• #5072: 也仅与新文档一起保存环境对象

• #5035: qthelp builder allows dashes in qthelp_namespace

• LaTeX：默认情况下使用lualatex或xelatex xindy 作为UTF-8能够替代的 makeindex (参考文献： #5134 )。Sphinx升级后，请清理现有项目的 Latex 构建库，然后再进行新构建。

• #5163: Html：hlist项现在与顶部对齐

• highlightlang 在解析阶段处理指令

• #4000: LaTeX：模板已更改。以下元素已移至其中：

  • \begin{document}

  • shorthandoff 变量

  • maketitle 变量

  • tableofcontents 变量

已弃用

1.8.0b2

• sphinx.io.SphinxI18nReader.set_lineno_for_reporter() 被贬低

• sphinx.io.SphinxI18nReader.line 被贬低

• sphinx.util.i18n.find_catalog_source_file() 改变了；改变了 gettext_compact 参数已被弃用

• #5403: sphinx.util.images.guess_mimetype() 已经改变了； content 参数已弃用

1.8.0b1

• source_parsers 被贬低

• autodoc_default_flags 被贬低

• 快速入门： --epub 选项变为默认值，因此已弃用

• 丢弃基于函数的指令支持。目前，Sphinx只支持基于类的指令(请参见 Directive )

• sphinx.util.docutils.directive_helper() 被贬低

• sphinx.cmdline 被贬低

• sphinx.make_mode 被贬低

• sphinx.locale.l_() 被贬低

• #2157: Helper函数 warn() 不推荐使用FOR HTML Themes

• app.override_domain() 被贬低

• app.add_stylesheet() 被贬低

• app.add_javascript() 被贬低

• app.import_object() 被贬低

• app.add_source_parser() 改变了；改变了 后缀 参数已被弃用

• sphinx.versioning.prepare() 被贬低

• Config.__init__() 改变了；改变了 目录名 ， 文件名 和 tags 参数已被弃用

• Config.check_types() 被贬低

• Config.check_unicode() 被贬低

• sphinx.application.CONFIG_FILENAME 被贬低

• highlightlang 指令已弃用

• BuildEnvironment.load() 被贬低

• BuildEnvironment.loads() 被贬低

• BuildEnvironment.frompickle() 被贬低

• env.read_doc() 被贬低

• env.update() 被贬低

• env._read_serial() 被贬低

• env._read_parallel() 被贬低

• env.write_doctree() 被贬低

• env._nitpick_ignore 被贬低

• env.versionchanges 被贬低

• env.dump() 被贬低

• env.dumps() 被贬低

• env.topickle() 被贬低

• env.note_versionchange() 被贬低

• sphinx.writers.latex.Table.caption_footnotetexts 被贬低

• sphinx.writers.latex.Table.header_footnotetexts 被贬低

• sphinx.writers.latex.LaTeXTranslator.footnotestack 被贬低

• sphinx.writers.latex.LaTeXTranslator.in_container_literal_block 被贬低

• sphinx.writers.latex.LaTeXTranslator.next_section_ids 被贬低

• sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids 被贬低

• sphinx.writers.latex.LaTeXTranslator.restrict_footnote() 被贬低

• sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote() 被贬低

• sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids() 被贬低

• sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids() 被贬低

• sphinx.writers.latex.LaTeXTranslator.check_latex_elements() 被贬低

• sphinx.writers.latex.LaTeXTranslator.bibitems 被贬低

• sphinx.writers.latex.LaTeXTranslator.hlsettingstack 被贬低

• sphinx.writers.latex.ExtBabel.get_shorthandoff() 被贬低

• sphinx.writers.html.HTMLTranslator.highlightlang 被贬低

• sphinx.writers.html.HTMLTranslator.highlightlang_base 被贬低

• sphinx.writers.html.HTMLTranslator.highlightlangopts 被贬低

• sphinx.writers.html.HTMLTranslator.highlightlinenothreshold 被贬低

• sphinx.writers.html5.HTMLTranslator.highlightlang 被贬低

• sphinx.writers.html5.HTMLTranslator.highlightlang_base 被贬低

• sphinx.writers.html5.HTMLTranslator.highlightlangopts 被贬低

• sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold 被贬低

• sphinx.ext.mathbase 扩展名已弃用

• sphinx.ext.mathbase.math 节点已弃用

• sphinx.ext.mathbase.displaymath 节点已弃用

• sphinx.ext.mathbase.eqref 节点已弃用

• sphinx.ext.mathbase.is_in_section_title() 被贬低

• sphinx.ext.mathbase.MathDomain 被贬低

• sphinx.ext.mathbase.MathDirective 被贬低

• sphinx.ext.mathbase.math_role 被贬低

• sphinx.ext.mathbase.setup_math() 被贬低

• sphinx.directives.other.VersionChanges 被贬低

• sphinx.highlighting.PygmentsBridge.unhighlight() 被贬低

• sphinx.ext.mathbase.get_node_equation_number() 被贬低

• sphinx.ext.mathbase.wrap_displaymath() 被贬低

• 这个 trim_doctest_flags 的参数 sphinx.highlighting.PygmentsBridge 被贬低

有关详细信息，请参阅 deprecation APIs list .

新增特征

1.8.0b2

• #5388: 确保冻结的对象描述可重现

• #5362: Apidoc：添加 --tocfile 用于更改目录文件名的选项

1.8.0b1

• 添加 config-inited 事件

• 添加 sphinx.config.Any 表示配置值接受任何类型的值

• source_suffix 允许将文件扩展名映射到文件类型

• 添加 author 作为配置值

• #2852: ImgConverter：支持将GIF转换为PNG

• sphinx-build 命令支持i18n控制台输出

• 添加 app.add_message_catalog() 和 sphinx.locale.get_translations() 支持第三方扩展的翻译

• 辅助函数 warning() 添加了HTML主题

• 添加 Domain.enumerable_nodes 为域管理自己的可枚举节点（实验）

• 添加新的关键字参数 override 到应用程序API

• LaTeX：新钥匙 'fvset' 为 latex_elements 。对于XeLaTeX/LuaLaTeX的默认设置 fanvyvrb 在代码块中使用普通字体大小，而不是小字体大小(参考： #4793 )

• 添加 html_css_files 和 epub_css_files 用于从配置添加CSS文件

• 添加 html_js_files 用于从配置添加JS文件

• #4834: 确保设置的对象描述是可重现的。

• #4828: 允许覆盖 numfig_format 部分是。不需要完整的定义。

• 改进包括期间的警告消息(参考： #4818 )

• LaTeX：可单独定制 guilabel 和 menuselection (参考文献： #4830 )

• 添加 Config.read() 从配置文件创建新配置对象的ClassMethod

• #4866: 将Graphviz图表包装在 <div> 标牌

• 视图代码：添加 viewcode-find-source 和 viewcode-follow-imported 加载源代码而不加载

• #4785: 拿破仑：将字符串添加到翻译文件以进行本地化

• #4927: 将无效值传递给Highlight指令的linenothreshold选项时显示警告

• C++：

  • 添加 cpp:texpr 作为兄弟姐妹的角色 cpp:expr .

  • 添加对联合的支持。

  • #3593, #2683: 添加对使用以下名称开头的匿名实体的支持 @ 。

  • #5147: 添加对(大多数)字符文字的支持。

  • 支持主模板内的交叉引用实体，现在已正确记录。

  • #1552: 添加新的交叉引用格式 cpp:any 和 cpp:func 角色，用于引用特定的函数重载。

• #3606: MathJax应使用异步属性加载

• Html：输出 canonical_url 元数据，如果 html_baseurl SET(参考： #4193 )

• #5029: 自动汇总：暴露 inherited_members 到模板

• #3784: Mathjax：加法 mathjax_options 为mathjax的脚本标记提供选项

• #726, #969: Mathjax：加法 mathjax_config 给出mathjax的串联配置

• #4362: LaTeX：如果文档未更改，则不覆盖.tex文件

• #1431: LaTeX：添加字母数字枚举列表支持

• 增列 latex_use_xindy 对于UTF-8智能索引，默认为 True 如果 latex_engine 是 'xelatex' 或 'lualatex' 。(参考文献： #5134 ， #5192 ， #5212 )

• #4976: SphinxLoggerAdapter.info() 现在支持 location 参数

• #5122: SetupTools：支持挑剔选项

• #2820: AutoClass指令支持嵌套类

• 添加 app.add_html_math_renderer() 为HTML注册数学呈现程序

• 应用 trim_doctest_flags 所有建设者（参见文本、手册页）

• #5140: 链接检查：向HTTP客户端添加更好的Accept标头

• #4614: Sphinx-内部版本：添加 --keep-going 用于显示所有警告的选项

• 添加 math:numref 引用方程式的作用（与 eq ）

• 快速启动：默认情况下启用EPUB生成器

• #5246: 增列 singlehtml_sidebars 为Singlehtml生成器配置侧边栏

• #5273: Doctest：有条件地跳过doctest

• #5306: AutoDoc：发出无效类型提示的警告

• #4075, #5215: AUTODOG：添加 autodoc_default_options 它接受选项值作为DICT

修复错误

1.8.0b2

• HTML：如果滚动，搜索框将覆盖到其他元素

• I18N：翻译目录的警告行号错误(参考： #5321 )

• #5325: LaTeX：交叉引用已被多个标签对象打破

• C++，修复了符号添加和查找。查找不应再在部分生成中中断。另请参阅 #5337 。

• #5348: 未显示对远程文件的下载引用

• #5282: 超文本标记语言主题： pygments_style 主题的内容被替换为 conf.py 默认情况下

• #4379: 排除文档时，Toctree显示令人困惑的警告

• #2401: AutoDoc： :members: 成因 :special-members: 不会被展示

• autoDoc:importError被更深模块的attributeError替换

• #2720, #4034: 与的链接不正确 :download: 、重复名称和并行构建

• #5290: AUTODOC：无法分析鸡蛋包中的源代码

• #5399: 如果存在未知的po文件，Sphinx会崩溃

1.8.0b1

• I18N：每次初始化时都会重置消息目录

• #4850: LaTeX：未呈现脚注内的脚注

• #4945: I18N：修复IndexBuilder的lang_Country未正确回退。感谢朱胜景。

• #4983: ProductionList指令为令牌生成无效的ID

• #5132: Lualatex：如果索引的Word以Unicode字符开头，则PDF构建失败

• #5133: LaTeX：索引标题“符号”和“数字”未国际化

• #5114: Sphinx-Build：处理扫描文档时的错误

• EPub：在目录树上列出“self”时脊椎已断(参考： #4611 )

• #344: 自动汇总不理解模块级别属性的文档字符串

• #5191: C++，避免在函数中嵌套声明，以避免查找问题。

• #5126: C++，为某些模板参数类型添加缺少的isPack方法。

• #5187: C++，也可以解析声明器上的属性。

• C++，解析删除表达式和基本的新表达式。

• #5002: Graphviz：SVG不适应列宽

删除的功能

1.8.0b1

• sphinx.ext.pngmath 延伸

文档

1.8.0b1

• #5083: 修复国际化的错误Make.bat选项。

• #5115: 拿破仑：添加告诫 #4613 去看医生。

1.7.9版（2018年9月5日发布）

新增特征

• #5359: 通过对锚点进行排序，使生成的文本信息文件可重现

修复错误

• #5361: 如果文档使用INCLUDE指令，则在增量构建时崩溃

1.7.8版（2018年8月29日发布）

不兼容的更改

• 的类型 env.included 已更改为集合的dict

修复错误

• #5320: Intersphinx：如果提供的url无效，则崩溃

• #5326: manpage: crashed when invalid docname is specified as man_pages

• #5322: AutoDoc： Any 类型提示导致格式错误

• #5327: 使用生成的文件重新生成时出现“Document is not included in any toctree”(生成的文件不包含在任何目录树中)警告

• #5335: 快速入门：转义序列已显示与MacPorts的 Python

1.7.7版（2018年8月19日发布）

修复错误

• #5198: 仅包含并行生成的文件时，文档不在Toctree中时发出警告

• LaTeX：在LaTeX控制台输出中出现REDUTE“Token Not Allowed in a PDF字符串”HYERREF WARNING警告(参考： #5236 )

• LaTeX：在带有最新LaTeX的LaTeX控制台输出中禁止显示“重新设置警告：重新设置程序包已过时”(参考： #5237 )

• #5234: PDF输出：自Sphinx 1.5起中断了对纸张环境变量的使用

• LaTeX：修复 latex_engine 有关使用XeLaTeX/LuaLateX的拉丁文现代字体的文档(参考： #5251 )

• #5280: AutoDoc：修复复杂类型的错误类型批注

• AutoDoc:错误地呈现可选类型

• #5291: AutoDoc按ForwardRef类型崩溃

• #5211: AutoDoc：没有为函数工具生成文档。部分函数

• #5306: AutoDoc： getargspec() 引发无效类型提示的NameError

• #5298: Imgath：MATH_NUMBER_ALL导致公式在html中有两个数字

• #5294: Sphinx-PowerShell中的快速入门空白提示

1.7.6版（2018年7月17日发布）

修复错误

• #5037: Latex \sphinxupquote{} 俄语中的中断

• sphinx.testing使用了不推荐使用的pytest api； Node.get_marker(name)

• #5016: 启用推荐标记时崩溃。启用自动强化

• #5022: LaTeX：Debian/Ubuntu提供的Docutils包崩溃

• #5009: LaTeX：如果表格没有标题，表格的标签将消失

• #5048: 已使用编号为toctree的崩溃

• #2410: C、为宏呈现空的参数列表。

• C++，在没有模板参数的情况下修复完整模板专长。

• #4667: C++，修复了使用intersphinx时在全局范围内丢失引用的断言。多亏了艾伦·M·卡罗尔。

• #5019: AutoDoc：按换页字符崩溃

• #5032: AutoDoc：丢失旧样式类的第一个静态方法参数

• #5036: 快速入门：按Ctrl-U组合键可清除整行

• #5066: Html：默认不显示“Relationship”侧边栏

• #5091: LaTeX：未正确处理索引项中的大括号

• #5070: EPub：错误的内部HREF片段链接

• #5104: Apidoc：接口 sphinx.apidoc:main() 已经改变了

• #4272: 法国项目的PDF版本与XeTeX有问题

• #5076: 拿破仑用Python3.7引发RuntimeError

• #5125: Sphinx-Build：接口 sphinx:main() 已经改变了

• Sphinx建筑： sphinx.cmd.build.main() 指 sys.argv 而不是给定的参数

• #5146: Autosumary：当第一行文档字符串以文字符号结尾时发出警告

• 自动汇总：自动汇总警告指示错误位置(参考： #5146 )

• #5143: AutoDoc：在检查不支持排序的类词典对象时崩溃

• #5139: AutoDoc：如果与另一个参数共享值，则缺少枚举参数

• #4946: PY域：rtype字段无法将“None”作为类型处理

• #5176: LaTeX：包含以下内容的术语的索引 @ ， ! ，或 " 失败

• #5161: Html：如果复制静态文件失败，则崩溃

• #5167: AutoDoc：修复具有两个以上参数的元组的格式类型批注

• #3329: I18N：被自动符号脚注引用崩溃

• #5158: 自动汇总：模块摘要以标题开头时已中断

1.7.5版（2018年5月29日发布）

修复错误

• #4924: HTML搜索：任何其他语言中的大写字符问题

• #4932: Apidoc：如果同级子包包含以下划线开头的模块，则忽略某些子包

• #4863, #4938, #4939: I18N不能正确处理用于目录、主题、警告、表格和章节的node.title。

• #4913: I18N：项目符号列表中的文字块不会翻译

• #4962: C++，在重复声明时引发TypeError。

• #4825: C++，正确解析expr角色，并在出现(转义的)换行符时提供更好的错误消息。

• 正确使用C++ desc_addname 用于名称前缀的节点。

• C++，在函数调用中解析包展开。

• #4915, #4916: 使用dirhtml构建器时，搜索页面上的链接断开

• #4969: AutoDoc：构造函数方法不应具有返回批注

• LaTex:以非1开头的深度嵌套枚举列表导致LaTex引擎崩溃

• #4978: LaTeX：未为巴西地区设置Shortandoff

• #4928: I18N：忽略点目录，如LC_Messages/中的.git/

• #4946: PY域：类型字段无法将“None”作为类型处理

• #4979: LaTeX：索引项中花括号的转义不正确

• #4956: AutoDoc：无法从模拟模块上的类的子类中提取文档

• #4973: LaTeX：词汇表指令为每一项添加空格

• #4980: LaTeX：代码块上的显式标签重复

• #4919: 如果toctree具有：Numed：选项，则node.asdom()崩溃

• #4914: AUTODOC：使用没有默认值的数据类时出现解析错误

• #4931: AUTODOC：当AUTODOC-SKIP-MEMBER的处理程序引发错误时崩溃

• #4931: AutoDoc：拿破仑模块处理模拟类的子类时崩溃

• #5007: 当错误日志包含“%”字符时，Sphinx-Build崩溃

1.7.4版（2018年4月25日发布）

修复错误

• #4885, #4887: 域：与重复对象一起崩溃

• #4889: LaTeX：sphinx.Writers.lacex导致递归导入

1.7.3版（2018年4月23日发布）

修复错误

• #4769: AutoDoc将丢失第一个静态方法参数

• #4790: 自动汇总：PDF版本中的两个列表太宽

• #4795: 通过以下方式定制 Latex _templates/longtable.tex_t 已经坏了

• #4789: ImgConverter：被Windows的Convert.exe迷惑

• #4783: 在Windows上，当srcdir和outdir的驱动器不同时，Sphinx崩溃

• #4812: AutoDoc忽略带类型注释的变量

• #4817: 警告消息上的URL错误

• #4784: LaTeX： latex_show_urls 如果替换项内存在超链接，则分配错误的脚注编号

• #4837: 带有类回忆录的LaTeX错误：字体命令 \sf 不受支持

• #4803: LaTeX：与自动编号的脚注数量比例太慢

• #4838: HtmlHelp：.hhp文件中的条目未排序

• toctree指令尝试为具有查询字符串的URL全局分配

• #4871: Html搜索：德语中的大写字符问题

• #4717: LaTeX：使用LuaLaTeX和XeLaTeX编译德语文档失败

• #4459: 重复标签检测器在并行构建中不能正常工作

• #4878: 带有返回无效元数据的扩展的崩溃

1.7.2版（2018年3月21日发布）

不兼容的更改

• #4520: Apidoc：带有空的文件夹 __init__. PY不再被排除在TOC之外

修复错误

• #4669: Sphinx.Build_Main和sphinx.make_main引发名称错误

• #4685: 自动汇总发出无意义的警告

• AutoDoc:当给定的选项无效时崩溃

• PYDOMAIN：如果为空，则始终去掉括号(参考： #1042 )

• #4689: 自动摘要：意外地剥离包含“”的文档字符串。

• #4701: 视图代码：放错了位置 <div> 在视图代码html输出中

• #4444: 不要求使用：NumREF：ON SECTIONS

• #4727: 包TextComp的选项冲突

• #4725: Sphinx不能与Python 3.5.0和3.5.1一起使用

• #4716: 在Windows上使用TexLive生成PDF文件，找不到文件错误

• #4574: LaTeX中公式前的垂直空间

• #4720: 图像与构建器不匹配时出现的消息不清楚

• #4655, #4684: 波兰语和汉语中的不完整本地化字符串

• #2286: 当呈现HTML页面时出现错误时，Sphinx崩溃

• #4688: 下载具有长URL的远程图像时出错

• #4754: sphinx/pycode/__init__. PY引发属性错误

• #1435: Qthelp构建器应该html转义关键字

• epub:修复toc.ncx的doctitle元素未转义

• #4520: Apidoc：TOC中不包含的子包(在1.6.6中引入)现已修复

• #4767: Html：搜索突出显示打破Mathjax公式

1.7.1版（2018年2月23日发布）

已弃用

• #4623: sphinx.build_main() 已弃用。

• 自动摘要：的接口 sphinx.ext.autosummary.get_documenter() 已更改（从1.7.0开始）

• #4664: sphinx.ext.intersphinx.debug() 已弃用。

有关详细信息，请参阅 deprecation APIs list .

修复错误

• #4608: EPub：生成的meta标记无效

• #4260: AutoDoc：如果仅关键字参数分隔符出现在参数列表顶部，则它不会消失

• #4622: EPub： epub_scheme 不影响内容。opf

• #4627: Graphviz：将Graphviz图像调整到页面大小

• #4617: 快速入门：需要PROJECT_DIR参数

• #4623: Sphinx.Build_Main在1.7.0中不再存在

• #4615: 的论据 sphinx.build 已在1.7.0中进行了更改

• 自动摘要：的接口 sphinx.ext.autosummary.get_documenter() 已更改

• #4630: 在sphinx中对msgid进行排序。pot确定性

• #4563: 自动摘要：不正确的行尾标点符号检测

• #4577: 显式以错误数字开头的枚举子列表

• #4641: 目录中的外部链接不能包含“？”使用 :glob: 选择权

• 在表达式解析中添加显式转换和Type的缺失解析。

• C++中添加缺失解析 this 在表达式分析中。

• #4655: 修复波兰语中不完整的本地化字符串

• #4653: 修复了无参数导入错误的错误报告

• #4664: 读取对象.inv再次失败

• #4662: any 参考文献： term 遇到歧义时，目标会崩溃

1.7.0版（2018年2月12日发布）

依赖关系

1.7.0b1

• 添加 packaging 包裹

不兼容的更改

1.7.0b1

• #3668: 每个命令的主函数的参数都已更改

• #3893: 未知的html_主题_选项引发警告而不是错误

• #3927: Python参数/变量类型应与类匹配，而不是与所有对象匹配

• #3962: Sphinx-apidoc现在将给定的目录识别为隐式名称空间包 --implicit-namespaces 给定的选项，而不是给定目录的子目录。

• #3929: Apidoc：将sphinx.apidoc移动到sphinx.ext.apidoc

• #4226: Apidoc：生成新的样式Makefile(Make-模式)

• #4274: 参数错误时，Sphinx-Build返回2作为退出代码

• #4389: 加载扩展模块后将创建输出目录

• AutoDoc不会向生成的文档生成警告消息，即使 keep_warnings 是 True 。它们只被排放到stderr。

• 从生成的conf.py中删除shebang行

• #2557: AutoDoc： autodoc_mock_imports 仅模拟指定的模块及其后代。它不嘲笑他们的祖先。如果你想嘲笑他们，请明确说明祖先的名字。

• #3620: HTML主题：将DOCUMENTION_OPTIONS移至独立的JavaScript文件(参考： #4295 )

• #4246: 限制所有主题的文本正文宽度。可通过主题选项进行配置 body_min_width 和 body_max_width 。

• #4771: Apidoc：The exclude_patterns 如果参数紧跟在命令行选项之后，则参数将被忽略

1.7.0b2

• #4467: html theme: Rename csss block to css

已弃用

1.7.0b1

• 使用字符串值 html_sidebars 已弃用，2.0只接受列表值。

• format_annotation() 和 formatargspec() 已弃用。请使用 sphinx.util.inspect.Signature 相反。

• sphinx.ext.autodoc.AutodocReporter 被替换为 sphinx.util.docutils. switch_source_input() 现在已经不受欢迎了。它将在Sphinx 2.0中删除。

• sphinx.ext.autodoc.add_documenter() 和 AutoDirective._register 现已弃用。请使用 app.add_autodocumenter() 相反。

• AutoDirective._special_attrgetters 现已弃用。请使用 app.add_autodoc_attrgetter() 相反。

新增特征

1.7.0b1

• 句柄C++ decltype(auto) .

• #2406: C++，添加了对表达式的正确解析，包括标识符的链接。

• 添加一个 cpp:expr 插入内嵌C++表达式或类型的角色。

• C++，用速记支持显式成员实例化 template 前缀

• C++，使函数参数可链接，如模板参数。

• #3638: Allow to change a label of reference to equation using math_eqref_format

• 现在 suppress_warnings 接受以下配置：

  • ref.python (参考文献： #3866 )

• #3872: 添加LaTeX键以配置PDF输出中的文字块标题位置(参考 #3792 ， #1723 )

• 如果缺少文档字符串，请尝试从基类中检索文档(参考： #3140 )

• #4023: 澄清任何角色具有多个目标时的错误消息。

• #3973: EPub：允许覆盖构建日期

• #3972: EPub：按文件名对清单条目进行排序

• #4052: View code：在突出显示模块代码之前进行排序

• #1448: qthelp: Add new config value; qthelp_namespace

• #4140: HTMLThemes：使Body标签可继承

• #4168: 用界面吧改进zh搜索

• HTML主题可以通过 theme.conf

• #3160: Html：使用 <kdb> 来代表 :kbd: 角色

• #4212: 自动汇总：在导入模块时捕获所有异常

• #4166: 增列 math_numfig 有关公式按部分编号的信息(参考： #3991 ， #4080 )。多亏了奥利弗·扬。

• #4311: 让 Latex 服从 numfig_secnum_depth 用于图形、表格和代码块

• #947: autodoc now supports ignore-module-all to ignore a module's __all__

• #4332: 让 Latex 服从 math_numfig 用于公式编号

• #4093: Sphinx-Build为未知目标/构建器创建空目录

• 添加 top-classes 选项为 sphinx.ext.inheritance_diagram 扩展以限制继承图的范围。

• #4183: 文档测试： :pyversion: 选件也遵循PEP-440规范

• #4235: 超文本标记语言：添加 manpages_url 将手册页角色设置为超链接的步骤

• #3570: AUTODOG：不显示“正在键入”用于类型提示的模块

• #4354: Sphinx-Build现在发出完成消息。构建者可以通过以下方式进行修改 Builder.epilog 属性

• #4245: HTMLThemes：添加 language 添加到javascript变量列表

• #4079: 超文本标记语言：添加 notranslate 类到每个代码块、文字和数学，让Google翻译知道它们是不可翻译的

• #4137: Doctest：doctest块始终突出显示为python控制台(Pycon)

• #4137: Doctest：测试代码块始终突出显示为python

• #3998: text: Assign section numbers by default. You can control it using text_add_secnumbers and text_secnumber_suffix

1.7.0b2

• #4271: Sphinx-Build支持一个名为 -j auto 自动调整进程数。

• 拿破仑：添加了用于指定自定义节标记的选项。

删除的功能

1.7.0b1

• 配置变量

  • html_use_smartypants

  • latex_keep_old_macro_names

  • latex_elements['footer']

• 的实用方法 sphinx.application.Sphinx 班

  • BuilderName（属性）

  • _显示块（）

  • 旧的_状态_迭代器（）

  • 状态迭代器（）

  • _指令_helper（）

• 的实用方法 sphinx.environment.BuildEnvironment 班

  • currModule（属性）

  • currclass（属性）

• EPUB2生成器

• warn（）的prefix和colorfunc参数

• sphinx.util.compat 模块

• sphinx.util.nodes.process_only_nodes()

• Latex 环境 notice 使用 sphinxadmonition 相反

• LaTeX \sphinxstylethead 使用 \sphinxstyletheadfamily

• C++，支持函数概念。多亏了米克的CPP。

• 未使用，以前未记录 Latex 宏 \shortversion 和 \setshortversion

修复错误

1.7.0b1

• #3882: 更新HTMLHelp和QTHelp的文件顺序

• #3962: Spinx-apidoc不能正确识别隐式名称空间包

• #4094: C++，允许模板参数列表为空。

• C++，也是具有限定名称的声明名中的超链接类型。

• C++中，不要为概念中的声明添加索引条目。

• C++支持依赖名的模板消歧器。

• #4314: 对于PDF的HOWTO文档，代码块的编号与图和表的编号不同

• #4330: PDF文档的默认LaTeX TocDepth计数器设置不一致

• #4198: Autosumary发出多个‘AutoDoc-Process-Docstring’事件。多亏了乔尔·诺斯曼。

• #4081: 生成时，警告和错误的颜色相同

• Latex ：如果 release 未设置

1.7.0b2

• #4415: AutoDoc将继承的类方法归类为常规方法

• #4415: AutoDoc将继承的静态方法归类为常规方法

• #4472: 未定义DOCUMENT_OPTIONS

• #4491: AutoDoc：在sys.meta_Path中首选_MockImporter而不是其他导入器

• #4490: AutoDoc：类型批注与Python3.7.0a4+断开

• 不再安装utils包

• #3952: Apidoc：模块标头太过转义

• #4275: Sphinx.util.i18n.Format_Date接受的格式受到限制

• #4493: 如果启用AutoStructify，则重新标记将引发AttributeError

• #4209: Intersphinx：在链接标题中，如果目标没有版本，则“v”应该是可选的

• #4230: 使用Sphinx 1.6编写页面的速度较慢

• #4522: EPub：即使配置更改，也不会重建文档

1.7.0b3

• #4019: 继承性_图表属性停止生成进程时出错

• #4531: 自动汇总：方法不被视为属性

• #4538: AutoDoc： sphinx.ext.autodoc.Options 已被转移

• #4539: AutoDoc发出对部分方法的警告

• #4223: Doctest：在错误的文件、错误的行上报告失败的测试

• I18N：如果给出了特定的文件名，则不编译消息目录 sphinx-build AS参数(参考： #4560 )

• #4027: AutosectionLabel现在希望标签与原始源代码中的标签相同；没有智能引号，没有花哨的东西。

• #4581: Apidoc：排除的模块仍包括在内

测试

1.7.0b1

• 添加对Docutils 0.14的支持

• 为添加测试 sphinx.ext.inheritance_diagram 延伸。

1.6.7版（2018年2月4日发布）

修复错误

• #1922: Html搜索：法语中的大写字符问题

• #4412: 将jQuery版本从3.1.0更新到3.2.1

• #4438: 计算：对带有空格的标签进行计算会导致html错误

• #2437: 完全引用类，别名为“alias of”

• #4434: 作为链接目标的纯数字会产生警告

• #4477: 生成特定文件后生成失败

• #4449: Apidoc：包含包含模块的“空”包

• #3917: 引文标签转换为省略号

• #4501: Graphviz：如果图形不可单击，则会导致EPUB3验证错误

• #4514: Graphviz：针对Graphviz生成的错误贴图ID的解决方法

• #4525: AutosectionLabel不支持并行生成

• #3953: 当存在正在运行的Intersphinx清单时，不要发出警告

• #4487: 数学：在并行构建时引发ValueError。多亏了jschueller。

• #2372: 自动汇总：为带类型批注的函数显示无效签名

• #3942: html: table is not aligned to center even if :align: center

1.6.6版（2018年1月8日发布）

新增特征

• #4181: AutoDoc：尽可能对词典关键字进行排序

• VerbatimHighlightColor 是一种新的 LaTeX 'sphinxsetup' 关键字(参考文献： #4285 )

• 代码块呈现中涉及的LaTex宏的更容易自定义

• 如果conf.py引发异常，则显示跟踪(参考： #4369 )

• 增列 smartquotes 通过以下方式禁用智能报价 conf.py (参考文献： #3967 )

• 增列 smartquotes_action 和 smartquotes_excludes (参考文献： #4142 ， #4357 )

修复错误

• #4334: Spinx-apidoc：不生成对TOC中不存在文件的引用

• #4206: LaTeX：段落之间的静止标签丢失换行符

• #4231: Html：仅在Firefox下应用FixFirefoxAnclBug

• #4221: 拿破仑依赖于AutoDoc，但用户需要手动加载

• #2298: 自动模块无法记录类属性

• #4099: C++：从构造函数内部正确地将类引用链接到类

• #4267: PDF版本被Unicode U+2116 Numero符号字符破坏

• #4249: PDF输出：Pygments错误突出显示增加了代码块中的行距

• #1238: 支持 :emphasize-lines: 在PDF输出中

• #4279: 使用多个进程和远程映像运行时，Sphinx因酸洗错误而崩溃

• #1421: 尊重Sphinx中的安静旗帜-快速入门

• #4281: 创建输出目录时的争用条件

• #4315: 对于PDF《HOWTO》文档， latex_toplevel_sectioning='part' 生成 \chapter 命令

• #4214: 两个Todolist指令破坏了Sphinx 1.6.5

• 使用intersphinx修复指向外部选项文档的链接(参考： #3769 )

• #4091: 未经记录的私人成员：UNDOC-成员：

1.6.5版（2017年10月23日发布）

新增特征

• #4107: 使搜索工具.js与Sphinx1.5之前的模板兼容

• #4112: 如果SMART_QUOTES设置已设置，则不要覆盖该设置

• #4125: 在I18N警告消息上显示原文和译文的参考文本

• #4147: 记录PO/MO文件读/写时包含异常

修复错误

• #4085: 使用解析文字从图像生成PDF失败 :align: 选择权

• #4100: 从AutoDoc扩展中删除调试打印

• #3987: 更改主题，从 alabaster 导致HTML构建失败

• #4096: C++，当使用错误的角色类型时，不要崩溃。多亏了Mitya57。

• #4070, #4111: 警告消息包含格式字符串时崩溃(再次)

• #4108: 搜索词突出显示打断SVG图像

• #3692: 如果写入.BuildInfo失败，则无法构建HTML

• #4152: 如果将字段列表放置在文档顶部，则HTML编写器会崩溃

• #4063: Sphinx crashes when labeling directive .. todolist::

• #4134: [doc] docutils.conf is not documented explicitly

• #4169: 中文不会自动触发中文搜索

• #1020: Ext.todo Todolist未链接到pdflatex中的页面

• #3965: 新的快速入门在Makefile中生成错误的SPHINXBUILD

• #3739: :module: 选项的内容被忽略。

• #4149: Documentation: Help choosing latex_engine

• #4090: [doc] latex_additional_files with extra LaTeX macros should not use .tex extension

• 无法将REST解析器错误转换为警告(参考： #4132 )

1.6.4版（2017年9月26日发布）

新增特征

• #3926: 增列 autodoc_warningiserror 压制…的行为 -W 在AutoDoc上导入目标模块时的选项

修复错误

• #3924: 动态解析扩展中的RST后丢失Docname

• #3946: Sphinx.sted中的拼写错误(这是一个在默认上下文中没有影响的错误)

• PEP:

  和：rfc：不支持 default-role 指令(参考： #3960 )

• #3960: DEFAULT_ROLE=‘Guilabel’不起作用

• 遗失 texinputs_win/Makefile 在Windows上的latexpdf生成器中使用。

• #4026: 性质：修复MacOS Safari滚动条颜色

• #3877: 修复了C++多行签名。

• #4006: 修复并行构建中的崩溃

• #3969: 私有实例属性导致AttributeError

• #4041: C++，删除函数指针中多余的名称链接。

• #4038: C、添加缺少的文档 member 角色。

• #4044: 空的多列单元格会导致PDF输出中出现额外的行高

• #4049: 修复sphinx-Build-h输出中的拼写错误

• #4062: 在Python3上，hashlib.sha1()必须采用字节，而不是Unicode

• 避免在LaTeX中的索引项之后缩进(参考： #4066 )

• #4070: 当警告消息包含格式字符串时崩溃

• #4067: 生成子进程失败时返回非零退出状态

• #4055: Graph viz：：Align：选项不适用于SVG输出

• #4055: Graph viz：：ALIGN：CENTER选项不适用于LaTeX输出

• #4051: warn() 用于HTML主题输出‘None’字符串的函数

1.6.3版（2017年7月2日发布）

新增特征

• LaTeX：提示代码块在下一页继续(参考： #3764 ， #3792 )

修复错误

• #3821: 无法使用Docutils 0.14rc1导入sphinx.util.comat

• #3829: sphinx-quickstart template is incomplete regarding use of alabaster

• #3772: “str Object”没有属性“FileName”

• 如果引文标签包含连字符，则发出错误警告(参考文献： #3565 )

• #3858: 使用--COLOR选项时，某些警告不会着色

• #3775: 删除默认模板中不需要的空格

• #3835: 如果项目目录名称包含空格，则sphinx.ext.imgath无法转换SVG图像

• #3850: 修复生成模式的帮助命令中的颜色处理

• #3865: 在Sphinx扩展中使用self.env.warn失败

• #3824: 自Sphinx 1.6.1起，生产列表应用智能报价转换

• 胶乳：固定 \sphinxbfcode 吞下最初的参数空间

• #3878: 在PDF输出中，自动记录的类属性中的引号应为直引号

• #3881: 浮动到下一页的 Latex 图形有时会留下额外的垂直空白

• #3885: 重复的脚注引发IndexError

• #3873: Failure of deprecation warning mechanism of sphinx.util.compat.Directive

• #3874: 对跨文件引用的“引用未被引用”的虚假警告

• #3860: 当构建器不支持图像时，不要下载图像

• #3860: 不带文件名分隔符构建器的远程映像URI不支持远程映像

• #3833: 命令行消息被无意地转换为 language 布景。

• #3840: 进行检查 epub_uid 严格

• #3851, #3706: 关于PDF输出的方框图形字符的修复

• #3900: 自动汇总找不到方法

• #3902: 如果出现以下情况，则发出错误 latex_documents 在py2中包含非Unicode字符串

1.6.2版（2017年5月28日发布）

不兼容的更改

• #3789: 不需要为>=3.5的python键入模块

修复错误

• #3754: 如果HTML主题附加了自己的样式表，则HTML构建器崩溃

• #3756: EPub：未定义实体‘mdash’

• #3758: 如果在conf.py中发出日志，则Sphinx崩溃

• #3755: 不正确地警告有关带有文本包含的DEDET

• #3742: RTD PDF builds of Sphinx own docs are missing an index entry in the bookmarks and table of contents. This is rtfd/readthedocs.org`#2857 <https://github.com/rtfd/readthedocs.org/issues/2857>`_ issue, a workaround is obtained using some extra LaTeX code in Sphinx's own conf.py

• #3770: 当“代码块”具有选项Emphasis-Lines并且所指示的数目大于行数时，构建失败

• #3774: 使用引文时，增量式的HTML构建中断

• #3763: 如果设置了epub_cover，则会出现epubcheck验证错误

• #3779: 由于“sys.meta_path”已损坏，所以sphinx.ext.autodoc.中的“ImportError”。多亏了塔蒂亚娜·特雷申科。

• #3796: 当给出非文档节点时，env.Resolve_Reference()崩溃

• #3803: 带有无效PO文件的Sphinx崩溃

• #3791: 长表的PDF“下一页续”未国际化

• #3788: 智能引号会对不受支持的语言发出警告

• #3807: 用于以下用途的 Latex 生成文件 make latexpdf 仅适用于unixen

• #3781: Option指令中的双连字符被编译为尾号

• #3817: Latex 建造商引发AttributeError

1.6.1版（2017年5月16日发布）

依赖关系

1.6b1

• （更新） Latex 输出用Ubuntu Trusty的TexLive软件包进行测试（2014年2月），早期的Tex安装可能不完全符合要求，特别是在Unicode引擎Xeletex和Luamatex方面。

• (添加)以下项需要latexmk make latexpdf 在GNU/Linux和Mac OS X上(参考： #3082 )

不兼容的更改

1.6b1

• #1061, #2336, #3235: 现在，默认情况下自动汇总的生成不包含导入的成员。多亏了吕克·萨弗尔。

• LaTeX \includegraphics 命令没有过载：仅 \sphinxincludegraphics 具有自定义代码，以便在图像过大时使其适合可用宽度。

• 的子类 sphinx.domains.Index 应该重写 generate() 方法。默认实现引发NotImplementedError

• LaTeX将长桌子水平居中放置，短桌子向左齐平(桌子周围没有文字流动)。在这两种情况下，位置现在都默认为中心，并且它将遵守Docutils 0.13 :align: 选项(参考 #3415 ， #3377 )

• 选项指令还允许选项名称使用所有标点符号(参考： #3366 )

• #3413: 如果 literalinclude %s :start-after: 是使用的，则使 :lines: 相对(参考 #3412 )

• literalinclude 指令不允许组合 :diff: 选项和其他选项(参考： #3416 )

• LuaLaTeX引擎使用 fontspec 比如XeLaTeX。建议您 latex_engine = 'lualatex' 仅在最新的TeX安装上使用(参考 #3070 ， #3466 )

• latex_keep_old_macro_names 缺省值已从 True to False. This means that some LaTeX macros for styling are by default defined only with \sphinx.. 带有前缀的名称。(参考文献： #3429 )

• LaTeX Long Tablet的页脚“下一页续”现在未加边框(参考： #3497 )

• #3529: 的论据 BuildEnvironment.__init__ 已更改

• #3082: 对pdf(和dvi)目标使用latexmk(仅限类Unix平台)

• #3558: 如果脚注和引文未被引用，则发出警告。这些警告可以通过以下方式取消 suppress_warnings 。

• LaTeX从随Plain Tex的pdftex引擎分发的文件中提供(未记录的)颜色宏。删除此选项是为了更好地支持多个TeX引擎。仅接口来自 color 或 xcolor 包应由Sphinx LaTeX编写器的扩展使用。(参考文献) #3550 )

• Builder.env 在实例化时未填充

• #3594: LaTeX：单个RAW指令已被视为块级元素

• #3639: 如果 html_experimental_html5_writer 是可用的，epub Builder默认使用它。

• Sphinx.add_source_parser() 如果重复，则引发错误

1.6b2

• #3345: 将定制的Smartyants代码替换为Docutils的SMART_QUOTES。感谢Dmitry Shachnev和Docutils的Günter Milde。

1.6b3

• LaTeX包 eqparbox 不再被Sphinx使用和装载

• LaTeX包装 multirow 不再被Sphinx使用和装载

• 在标准域的引用数据中添加行号

1.6决赛

• Latex 包装 threeparttable 不再由Sphinx使用和加载(参考 #3686 ， #3532 ， #3377 )

删除的功能

• 配置变量

  • epub3_contributor

  • epub3_description

  • epub3_page_progression_direction

  • html_translator_class

  • html_use_modindex

  • latex_font_size

  • latex_paper_size

  • latex_preamble

  • latex_use_modindex

  • latex_use_parts

• termsep 结点

• defindex.html模板

• 中的ldml格式支持 today ， today_fmt 和 html_last_updated_fmt

• :inline: sphinx.ext.graphviz扩展指令选项

• Sphinx.ext.pngmath扩展

• sphinx.util.compat.make_admonition()

新增特征

1.6b1

• #3136: Add :name: option to the directives in sphinx.ext.graphviz

• #2336: 增列 imported_members 选项以 sphinx-autogen 命令来记录导入的成员。

• 添加 :tparam-line-spec: 模板化声明的选项。指定后，每个模板参数将在单独的行上呈现。

• #3359: 允许用户区域设置目录中的sphinx.js覆盖Sphinx中的sphinx.js

• #3303: 增列 :pyversion: 选项添加到doctest指令。

• #3378: (LaTeX)支持 :widths: 表指令选项(参考： #3379 ， #3381 )

• #3402: 允许使用以下命令抑制“下载文件不可读”警告 suppress_warnings 。

• #3377: LaTeX：添加对Docutils 0.13的支持 :align: 选项(但不实现文本绕表流动)。

• LaTeX：表格内部的脚注是超链接的(标题或页眉除外)(参考： #3422 )

• 如果检测到On超限，则发出警告 literalinclude 指令(参考： #3416 )

• 用于LuaLaTeX与XeLaTeX相同的默认设置(即 fontspec 和 polyglossia )。(参考文献： #3070 ， #3466 )

• 制作 'extraclassoptions' 的关键字 latex_elements 公共(参考文献) #3480 )

• #3463: 为必需的EPUB3元数据添加警告消息。将默认值添加到 epub_description 以避免像其他设置那样发出警告。

• #3476: 安装工具：支持多个构建器

• LaTeX：LaTeX表格中合并的单元格允许代码块、列表、块引号...正常细胞也是如此(参考： #3435 )

• HTML构建器使用实验性的HTML5编写器IF html_experimental_html5_writer 是 True 并且安装了Docutils 0.13或更高版本。

• 用于在PDF输出中自定义表格前后间距的LaTeX宏(参考 #3504 )

• #3348: 在文本包含和视图代码指令中显示装饰符

• #3108: 如果：START-AT：和其他文本包含选项与文本不匹配，则显示警告

• #3609: Allow to suppress "duplicate citation" warnings using suppress_warnings

• #2803: 按入口点发现构建器

• #1764, #1676: 允许为样式表设置“”rel“”和“”title“”属性

• #3589: 支持非HTML构建器上的远程图像

• #3589: 在非HTML构建器上支持数据URI中的图像

• #2961: 改进 autodoc_mock_imports 。现在，配置值只需要声明应该模拟的顶级模块。多亏了罗宾·贾里。

• #3449: 在YY3上，AutoDoc使用检查签名来进行更准确的签名计算。多亏了纳撒尼尔·J·史密斯。

• #3641: EPub主题支持HTML5编写器生成的HTML结构。

• #3644 AutoDoc使用检查而不是检查类型。多亏了杰伦·德米耶。

• 添加新的扩展名； sphinx.ext.imgconverter . 它将文档中的图像转换为适合构建者的格式

• LaTeX：使用模板来呈现表格(参考 #3389 ，2a37b0e)

1.6b2

• LATEXMKOPTS 中生成文件的变量 $BUILDDIR/latex 将选项传递给 latexmk 在执行时 make latexpdf (参考文献) #3695 ， #3720 )

• 添加新事件 env-check-consistency 检查扩展的一致性

• 增列 Domain.check_consistency() 检查一致性

修复错误

1.6b1

• literalinclude 指令在删除后展开制表符(参考： #3416 )

• #1574: 表格单元格中的段落在Latex输出中不起作用

• #3288: 合并标题不换行文本的表格

• #3491: PDF中桌子和长桌周围的垂直空间不一致

• #3506: Html编写器中所有警告的分离函数现在可以正确传递 node 至 depart_admonition 。

• #2693: Sphinx LaTeX样式文件错误地禁止LaTeX+DVI(ps、pdf、pdfmx)部分标题的颜色

• C++，正确查找 any 参考文献。

• #3624: Sphinx.ext.intersphinx无法加载用gzip压缩的清单

• #3551: PDF信息词典缺少作者和标题数据

• #3351: Intersphinx不像这样引用上下文 py:module ， py:class 诸若此类。

• 如果父模板已存档，则无法加载模板文件

1.6b2

• #3661: Sphinx-Build在并行构建时崩溃

• #3669: GetText构建器失败，并显示“ValueError：Substring Not Found”

• #3660: Sphinx始终依赖于ShinxContrrib-WebSupport及其依赖

• #3472: LaTeX中的智能引号错误(至少通过自动属性使用字符串列表)(参考： #3345 ， #3666 )

1.6b3

• #3588: 即使在以下情况下，i18n文档构建中也没有精简(p标记)html输出 html_compact_lists 是 True 。

• 这个 make latexpdf 从1.6b1开始(对于GNU/Linux和Mac OS，使用 latexmk )在发生LaTeX错误的情况下更早中止，这是由于硬编码使用 --halt-on-error 选项(参考 #3695 )

• #3683: 默认情况下不提供sphinx.webSupport模块

• #3683: 如果调用了Builder.css_File.Insert()，则无法构建文档

• #3714: 未采用视频码扩展 highlight_code='none' 在帐上

• #3698: 移动：DOC：到STD域打破了向后兼容性

• #3633: 错误检测未引用的引文

1.6决赛

• Latex 表格不允许在标题单元格中有多个段落

• 自1.6b3以来，latexopts未正确传递到pdflatex

• #3532: 短表单元格中的图形或文字块标题会对PDF输出造成严重影响

• FIX：在PDF中，无论表格是否属于Longtable类，表格的字幕呈现方式都不同(参考 #3686 )

• #3725: 在 Latex 输出中，TODO看起来与NOTE不同

• #3479: 存根列对LaTeX输出没有影响

• #3738: Toping.py中无意义的代码

• #3746: PDF builds fail with latexmk 4.48 or earlier due to undefined options -pdfxe and -pdflua

已弃用

1.6b1

• sphinx.util.compat.Directive class is now deprecated. Please use instead docutils.parsers.rst.Directive

• sphinx.util.compat.docutils_version 现在已弃用

• #2367: Sphinx.warn(), Sphinx.info() and other logging methods are now deprecated. Please use sphinx.util.logging (日志API) instead.

• #3318: notice 现在已弃用作为LaTeX环境名称，并将在Sphinx 1.7中删除。扩展作者请使用 sphinxadmonition 相反(就像Sphinx从1.5开始所做的那样)。

• Sphinx.status_iterator() 和 Sphinx.old_status_iterator() 现已弃用。请使用 sphinx.util:status_iterator() 相反。

• Sphinx._directive_helper() 被贬低。请使用 sphinx.util.docutils.directive_helper() 相反。

• BuildEnvironment.set_warnfunc() 现在已弃用

• 以下方法 BuildEnvironment 现已弃用。

  • BuildEnvironment.note_toctree()

  • BuildEnvironment.get_toc_for()

  • BuildEnvironment.get_toctree_for()

  • BuildEnvironment.create_index()

  请使用 sphinx.environment.adapters 而不是模块。

• Latex 包装 footnote 不再由其捆绑的替换项加载 footnotehyper-sphinx 。重新定义的宏将保留与原始包中相同的名称。

• #3429: 不推荐使用配置设置 latex_keep_old_macro_names 。它将从1.7删除，并且其缺省值已经从 True 至 False 。

• #3221: Epub2构建器已弃用

• #3254: sphinx.websupport 现在被分成独立的包； sphinxcontrib-websupport 。 sphinx.websupport 将在Sphinx 2.0中删除。

• #3628: sphinx_themes Entry_POINT已弃用。请使用 sphinx.html_themes 取而代之的是。

1.6b2

• #3662: builder.css_files 已弃用。请使用 add_stylesheet() 而不是API。

1.6决赛

• LaTeX \sphinxstylethead 已在1.6中弃用，将在1.7中删除。请将自定义项移到新宏中 \sphinxstyletheadfamily .

测试

1.6决赛

• #3458: 增列 sphinx.testing (试验性)

版本1.6（未发布）

• 未释放（由于包脚本错误）

1.5.6版（2017年5月15日发布）

修复错误

• #3614: 带有请求的Sphinx崩溃-2.5.0

• #3618: 带有元组参数的AutoDoc崩溃

• #3664: 在Sphinx生产的 Latex 清单项目中，项目后面没有空格

• #3657: 如果存在以genindex开头的文档，ePub Builder将崩溃

• #3588: 即使在以下情况下，i18n文档构建中也没有精简(p标记)html输出 html_compact_lists 是 True 。

• #3685: 使用第三方域名时出现AttributeError

• #3702: LaTeX writer styles figure legends with a hard-coded \small

• #3708: LaTeX编写器允许IRC方案

• #3717: 停止强制要求收藏夹图标必须为.ico

• #3731, #3732: 针对非类参数保护is枚举类谓词

• #3320: 关于找不到容器类型的引用目标的警告

• 在makefile中为 Latex 构建保留库拼写错误的archiveprefix

1.5.5版（2017年4月3日发布）

修复错误

• #3597: 如果提供的名称无效，则Python域将引发UnundLocalError

• #3599: 迁移到新的MathJax CDN

1.5.4版（2017年4月2日发布）

新增特征

• #3470: 使genindex支持所有类型的字母，而不仅仅是拉丁字母

修复错误

• #3445: 设置 'inputenc' 关键是 \\usepackage[utf8x]{inputenc} 导致PDF构建失败

• epub文件重复 nav.xhtml 链接在 content.opf 除了第一次生成

• #3488: 在以下情况下，对象.inv已损坏 release 或 version 包含返回代码

• #2073, #3443, #3490: GetText构建器，写入POT文件，除非内容相同但没有创建日期。多亏了柴川义贵。

• #3487: Intersphinx：无法引用选项

• #3496: LaTeX Long Tablet的最后一栏可能比其内容宽得多

• #3507: ProductionList指令的LaTeX输出中的引号错误

• #3533: 从Sphinx 1.3.1迁移到1.5.3打破了以代码形式呈现的链接的LaTeX编译

• #2665, #2607: 链接C++文档字段中的名称，并使其可以用于其他域。

• #3542: C++，用模板修复了非类型模板参数的解析错误。

• #3065, #3520: Python域无法识别嵌套类

• #3575: 使用Sphinx构建的土耳其语文档中的pdflatex问题再次出现(参考 #2997 ， #2397 )

• #3577: 修复intersphinx调试工具

• LaTeX命令，如 \\large 插入到的标题项中 latex_documents 导致PDF构建失败(参考 #3551 ， #3567 )

1.5.3版（2017年2月26日发布）

新增特征

• 支持请求-2.0.0(试验性)(参考： #3367 )

• (LaTeX)PDF页面页边距尺寸可自定义(参考： #3387 )

• literalinclude 指令允许组合 :pyobject: 和 :lines: 选项(参考： #3416 )

• #3400: 生成模式在生成文档时不使用子流程

修复错误

• #3370: 不提取代码块的标题进行翻译

• LaTeX： release 未转义(参考： #3362 )

• #3364: Sphinx-QuickStart提示80个字符宽度的控制台溢出

• 自1.5版起，PDF的目录和书签缺少通用索引条目(参考： #3383 )

• #3392: 'releasename' 在……里面 latex_elements 不起作用了

• #3356: 日语页面布局 'manual' DocClass具有较短的文本区域

• #3394: 什么时候 'pointsize' 不是 10pt 、日语 'manual' 文档获取错误的PDF页面尺寸

• #3399: QuickStart：conf.py未被模板覆盖

• #3366: Option指令不允许使用标点符号

• #3410: 返回中的代码 release 中断html搜索

• #3427: AutoDoc：Windows上未剥离内存地址

• #3428: xetex build tests fail due to fontspec v2.6 defining \strong

• #3349: 结果是 IndexBuilder.load() 已经坏了

• #3450: &nbsp出现在EPUB文档中

• #3418: 搜索按钮性质和金字塔主题未对齐

• #3421: 无法翻译表的标题

• #3552: 链接检查引发UnundLocalError

1.5.2版（2017年1月22日发布）

不兼容的更改

• 依赖性要求更新：请求2.4.0或更高版本(参考： #3268 ， #3310 )

新增特征

• #3241: 如果出现错误，则发出 Latex 警告(参考 #3210 )

• #3194: 请参考$MAKE环境变量以确定 make 命令

• 对嵌套编号目录树发出警告(参考： #3142 )

• #978: intersphinx_mapping 还允许将列表作为参数

• #3340: ( Latex )排起长队 parsed-literal 都被包裹在里面 code-block 、内联数学和脚注功能齐全。

修复错误

• #3246: Xapian搜索适配器崩溃

• #3253: 在PY2环境中，使用非标题toctree构建另一个语言环境会产生 None 说明

• #185: 对包括原始节点的节标题的引用已中断

• #3255: 在Py3.4环境下，AutoDoc不支持正确的Enum类属性文档。

• #3261: latex_use_parts 让Sphinx崩溃

• 警告类型 misc.highlighting_failure 不起作用

• #3294: add_latex_package() 让撞车成为非 Latex 建筑商

• 表格的标题被呈现为无效的HTML(参考： #3287 )

• #3268: Sphinx在Debian Jessie的请求包中崩溃

• #3284: Sphinx在并行构建时崩溃，其扩展引发无法序列化的异常

• #3315: 参考书目崩溃的 Latex 构建与docclass的回忆录

• #3328: 无法隐式引用题目

• #3329: 如果po文件无效且无法读取，则会发出警告。也在写模子

• #3337: 定义列表术语的分类器的丑陋渲染

• #3335: GetText不提取field_list中的字段的field_name

• #2952: C++，修复对运算符()函数的引用。

• 修复中的Unicode上标和下标数字 code-block 和已解析的文字LaTeX输出(参考 #3342 )

• Latex 作家：离开 " 已解析的内部字符-原样文字(参考 #3341 )

• #3234: 编码清单的Intersphinx失败

• #3158: PDF输出中字幕后的空间太大

• #3317: 如果在PDF中使用连字符，则解析文本内容中的URL会被错误地呈现

• 如果通过替换以解析文字形式插入的图像的文件名包含连字符，则LaTeX崩溃 #3340 )

• 在已解析文本中插入脚注的LaTeX呈现错误(参考 #3340 )

• LaTeX不能很好地呈现已解析文本中的内联数学(参见 #3340 )

• #3308: 使用pdf构建器，已解析的文字不会换行很长(参考 #3340 )

• #3295: 无法导入扩展名sphinx.Builders.linkcheck

• #3285: 自动摘要：星号转义两次

• LaTeX，将dvipdfm选项传递给日语文档的几何程序包(参考 #3363 )

• fix parcelinenos（）无法分析左半开范围（参见“-4”）。

1.5.1版（2016年12月13日发布）

新增特征

• #3214: 允许抑制来自epub生成器的“未知MIMETYPE”警告 suppress_warnings 。

修复错误

• #3195: 不能并行构建

• #3198: 当toctree具有‘self’时引发AttributeError

• #3211: 删除未翻译的Sphinx区域设置目录(包含在未翻译的It_IT中)

• #3212: 使用Docutils 0.13时，HTML生成器崩溃

• #3207: 在已解析的文字指令中引用的更多LaTeX问题 (\DUrole )

• #3205: 使用旧的pyOpenSSL(<0.14)时，sphinx.util.请求崩溃

• #3220: 重复引用时出现KeyError

• #3200: LaTeX：不允许在desc_name中使用外部参照

• #3228: build_sphinx 命令在缺少依赖项时崩溃

• #2469: 忽略GetText生成器的编录文件更新。多亏了大久保弘。

• #3183: 生成的索引页中的随机跳转框顺序。

1.5版（2016年12月5日发布）

不兼容的更改

1.5a1

• Latex 包装盒不再是Sphinx的附属品。

• 使用 'locales' 作为缺省值 locale_dirs

• Latex ，包装，ifthen不再是Sphinx的依赖。

• LaTex，样式文件不修改FancyVRB的逐字（也可以作为原始逐字提供），而是使用SphinxVerbatim作为自定义包装器的名称。

• LaTeX，包NewFloat不再使用(且不包括在内)(参考 #2660 ；它从1.3.4开始使用，从1.4开始随Sphinx一起提供)。

• LaTeX，表格中的文字块不使用OriginalVerbatim，而使用处理标题和换行的sphinxVerbatimintable(参考 #2704 )。

• 胶乳替代品 pt 按Tex当量 bp 如果发现 width 或 height 图像的属性。

• Latex ，如果 width 或 height 图像的属性没有单位，请使用 px 而不是忽视它。

• Latex ：将Pygments的样式表单独保存到独立的.sty文件中

• #2454: SourceLink的文件名现在已更改。的价值 html_sourcelink_suffix 将被附加到原始文件名(如 index.rst.txt )。

• sphinx.util.copy_static_entry() 现已弃用。使用 sphinx.util.fileutil.copy_asset() 相反。

• sphinx.util.osutil.filecopy() 如果文件未更改，则跳过复制(参考： #2510 ， #2753 )

• 由于jQuery版本从1.11.0更新到3.1.0，已删除对Internet Explorer 6-8、Opera 12.1x或Safari 5.1+的支持(参考： #2634 ， #2773 )

• QtHelpBuilder不生成搜索页面(参考： #2352 )

• qtHelpBuilder使用 nonav 主题而不是默认主题，以提高可读性。

• Latex ：为了为日本文档提供良好的默认设置，Sphinx使用 jreport 和 jsbook 如果是DOCKET language 是 ja .

• sphinx-quickstart 现在允许项目版本为空

• 修复：下载：epub/qthelp builder上的角色。他们忽视了这个角色，因为他们不支持它。

• sphinx.ext.viewcode 默认情况下不在EPUB建筑上工作。 viewcode_enable_epub 选项

• sphinx.ext.viewcode 在SingleHTML生成器上禁用。

• 使用make模式 sphinx-quickstart 默认情况下。要禁用此功能，请使用 -M 选项

• 固定 genindex.html ，sphinx的文档模板，将地址链接到自身以满足xhtml标准。

• 默认情况下使用EPUB3 Builder。旧的epub构建器被重命名为epub2。

• 固定 epub 和 epub3 包含指向 genindex 即使 epub_use_index = False .

• html_translator_class 现在已弃用。使用 set_translator() 而不是API。

• 放下python 2.6和3.3支持

• 删除EPUB3生成器 epub3_page_progression_direction 选项（使用） epub3_writing_mode ）

• #2877: Rename latex_elements['footer'] to latex_elements['atendofbody']

1.5a2

• #2983: 改名 epub3_description 和 epub3_contributor 至 epub_description 和 epub_contributor 。

• 删除主题/basic/defindex.html；不再使用

• Sphinx不再发货（但仍在使用） Latex 风格的文件 fncychap

• #2435: 瘦身快速入门conf.py

• 这个 sphinx.sty Latex 包不加载自己的“超引用”，因为这是在 Latex 输出的前导码后面通过 'hyperref' 关键。

• Sphinx不再提供自定义修改过的 Latex 样式文件 tabulary . 使用未修改的包。

• #3057: 默认情况下，LaTeX PDF输出中的脚注标记前面不再有空格， \sphinxBeforeFootnote 如果需要，允许用户自定义。

• LaTeX目标需要该选项 hyperfootnotes 套餐数量 hyperref 保持其默认设置不变(即 true )(参考文献： #3022 )

1.5决赛

• #2986: themes/basic/defindex.html 现在已弃用

• 发出警告，默认情况下将在sphinx 1.6中弃用。用户可以通过设置环境变量pythonwarning来更改行为。请参阅 折旧警告 .

• #2454: 新的JavaScript变量 SOURCELINK_SUFFIX 已添加

已弃用

Sphinx 1.6中删除了这些功能：

• I18N功能中支持LDML格式

• sphinx.addnodes.termsep

• 中的一些函数和类 sphinx.util.pycompat ： zip_longest ， product ， all ， any ， next ， open ， class_types ， base_exception ， relpath ， StringIO ， BytesIO . 请改用标准库版本；

如果有类似 RemovedInSphinxXXXWarning 如有显示，请参阅 折旧警告 .

新增特征

1.5a1

• #2951: 增列 --implicit-namespaces 向apidoc提供PEP-0420支持。

• 添加 :caption: sphinx.ext.inheritance_图表的选项。

• #2471: 为默认的doctest标志添加配置变量。

• 将LinkCheck Builder转换为请求以更好地处理编码

• #2463, #2516: 将“meta”指令的关键字添加到搜索索引

• :maxdepth: Toctree选项会影响 secnumdepth (参考文献： #2547 )

• #2575: 现在 sphinx.ext.graphviz 允许 :align: 选择权

• 如果将未知密钥指定给 latex_elements

• 如果没有与匹配的域，则显示警告 primary_domain (参考文献： #2001 )

• C++，当角色类型对于它所引用的目标类型具有误导性时显示警告(例如，使用 class 功能的角色)。

• LaTeX，编写者将更多的文本样式抽象到可定制的宏中，例如 visit_emphasis 将输出 \sphinxstyleemphasis 而不是 \emph (它可能在其他地方使用或在添加的 Latex 包装中使用)。见末尾的列表 sphinx.sty (参考文献： #2686 )

• LaTeX是备注、警告和其他警告类型使用的环境和参数的公共名称，允许从 'preamble' 密钥或输入文件(参考：功能请求 #2674 ， #2685 )

• LaTeX，更好地计算某些表格的列宽(因此，由于表格现在正确地填充了行宽，因此会有轻微的变化；参考： #2708 )

• LaTeX、sphinxVerbatim环境更易于定制(参考： #2704 )。除了已有的VerbatimColor和VerbatimBorderColor之外：

  • 两长度 \sphinxverbatimsep 和 \sphinxverbatimborder ，

  • 布尔运算 \ifsphinxverbatimwithframe 和 \ifsphinxverbatimwrapslines .

• LaTeX，处理表格内文字块的标题，并对长代码行进行换行以适应表格单元格(参考： #2704 )

• #2597: 将警告消息显示为深红色

• Latex ，允许使用像素单位的图像尺寸（默认为96px=1in）

• 如果发现无效的维度单位，则显示警告

• #2650: 增列 --pdb Setup.py命令的选项

• Latex ，利用 Latex \small 对于可定制的代码清单(参考 #2721 )

• #2663: 增列 --warning-is-error Setup.py命令的选项

• 如果使用了不推荐使用的 Latex 选项，则显示警告

• 添加sphinx.config.enum以检查配置值是否在候选中

• 数学：在HTML输出中为每个公式添加超链接标记

• 添加新主题 nonav 不包括任何导航链接。这适用于任何帮助生成器，如qthelp。

• #2680: sphinx.ext.todo 如果出现以下情况，现在会发出警告 todo_emit_warnings 已启用。此外，它还发出一个名为 todo-defined 处理第三方扩展中的TODO条目。

• python域签名分析器现在使用xref mixin作为“exceptions”，允许异常类自动链接。

• #2513: 增列 latex_engine 通过conf.py切换LaTeX引擎

• #2682: C++，基本支持属性(C++11风格和GNU风格)。新的配置变量‘CPP_id_ATTRIBUTES’和‘CPP_PAREN_ATTRIBUTES’可用于引入定制属性。

• #1958: C++中，添加配置变量‘CPP_INDEX_COMMON_PREFIX’以从C++对象的索引文本中删除前缀。

• C++，增加了概念指令。多亏了米克的CPP。

• C++，增加了对模板引入语法的支持。多亏了米克的CPP。

• #2725: LaTeX Builder：允许使用用户定义的模板文件(实验性)

• apidoc现在通过不写入内容不变的文件来避免使缓存文件无效。如果经常运行apidoc，这可能会导致显著的性能胜利。

• #2851: sphinx.ext.math 如果找不到公式，则发出缺少引用的事件

• #1210: eqref 角色现在支持交叉引用

• #2892: Added -a (--append-syspath) option to sphinx-apidoc

• #1604: EPUB3生成器：在iBooks中查看时遵循与字体相关的CSS。

• #646: option 指令支持‘.作为选项的一部分的字符

• 添加有关KindleGen的文档并修复其文档结构。

• #2474: Add intersphinx_timeout option to sphinx.ext.intersphinx

• #2926: EPUB3构建器支持垂直模式 (epub3_writing_mode 选项)

• #2695: build_sphinx SetupTools的子命令处理异常的方式与 sphinx-build 会吗？

• #326: numref 角色还可以参考部分

• #2916: numref 角色还可以将标题作为其链接文本引用

1.5a2

• #3008: linkcheck 构建器忽略自签名证书URL

• #3020: 新的 'geometry' 关键是 latex_elements 其默认使用LaTeX样式文件 geometry.sty 设置页面布局的步骤

• #2843: 将：Start-At：和：End-At：选项添加到文本包含指令

• #2527: 增列 :reversed: Toctree指令的选项

• 增列 -t 和 -d 选项以 sphinx-quickstart 支持模板生成的Sphinx项目。

• #3028: Add {path} and {basename} to the format of figure_language_filename

• 新的 'hyperref' 按键输入 latex_elements 词典(参考文献 #3030 )

• #3022: 允许在LaTeX PDF输出的脚注中使用代码块

1.5b1

• #2513: XeLaTeX更好的默认设置

• #3096: 'maxlistdepth' 解决 Latex 列表限制的关键

• #3060: AutoDoc支持Enum类的属性文档。现在，自动对接只呈现Enum属性的值，而不是Enum属性表示。

• 增列 --extensions 至 sphinx-quickstart 支持从命令行启用任意扩展(参考： #2904 )

• #3104, #3122: 'sphinxsetup' FOR KEY=Sphinx LaTeX的值样式

• #3071: AutoDoc：允许模拟的模块装饰器原封不动地传递函数

• #2495: linkcheck: Allow skipping anchor checking using linkcheck_anchors_ignore

• #3083: 让Unicode不间断空格像LaTeX一样运行 ~ (固定 #3019 )

• #3116: 允许在PDF输出中为行内文字自动换行(参考 #3110 )

• #930: Spinx-apidoc允许使用通配符排除路径。多亏了尼克·科格伦。

• #3121: 添加 inlineliteralwraps 控制LaTeX中是否内联文字自动换行的选项

1.5决赛

• #3095: 增列 tls_verify 和 tls_cacerts 在Linkcheck和Intersphinx中支持自签名HTTPS服务器

• #2215: 可以从另一个目录调用由Shinx-QuickStart生成的Make.bat。多亏了提摩太·坎皮克。

• #3185: Add new warning type misc.highlighting_failure

修复错误

1.5a1

• #2707: (LaTeX)表格的列宽计算错误

• #2799: Sphinx在导入Sphinx模块时自动安装角色和指令。现在，Sphinx将它们安装在正在运行的应用程序上。

• sphinx.ext.autodoc 如果目标代码通过以下方式从模拟模块导入*，则崩溃 autodoc_mock_imports 。

• #1953: Sphinx.add_node does not add handlers the translator installed by html_translator_class

• #1797: 文本生成器在顶部插入空行

• #2894: QuickStart Main()不使用argv参数

• #2874: GetText生成器无法提取 only 指令

• #2485: 具有多个SOURCE_Suffix值的自动汇总崩溃

• #1734: 无法翻译toctree指令的标题

• 无法翻译元指令的内容(参考： #1734 )

• #2550: 外部链接在帮助查看器中打开

• #2687: 多次运行Sphinx会产生“已注册”警告

1.5a2

• #2810: 一份意大利文件中关于pdflat ex的问题

• 使用 latex_elements.papersize 指定makefile中 Latex 的纸张大小

• #2988: 链接检查：如果Head请求被拒绝，则使用GET请求重试

• #2990: 如果Linkcheck_Anchors已启用，则LinkCheck会引发“Can‘t Convert’bytes‘Object to STRIMPLICATE”错误

• #3004: 使用的链接类型“top”和“up”无效

• #3009: 自Sphinx 1.4.4以来，LaTeX中的已解析文字呈现不佳

• #3000: option 指令生成无效的HTML锚

• #2984: 如果出现以下情况，则生成无效的HTML html_split_index 启用

• #2986: 应该将Themes/Basic/findex.html更改为HTML5友好

• #2987: 如果将多个ID分配给一个列表，则会生成无效的HTML

• #2891: HTMLSearch不能提供所有结果

• #1986: PDF输出中的标题

• #147: LaTeX章节风格的问题

• #3018: 具有页面布局尺寸和章节标题的LaTeX问题

• 用来解决问题 \pysigline 在LaTeX样式文件中(参考 #3023 )

• #3038: sphinx.ext.math* 如果标签重复，则引发TypeError

• #3031: incompatibility with LaTeX package tocloft

• #3003: Latex不支持脚注中的文字块

• #3047: Pdf输出中脚注前的空格不连贯，允许换行

• #3045: 如果现在是html，则html搜索索引创建者应忽略“原始”内容

• #3039: 如果单词大写，则英语词干分析器返回错误的单词

• 修复生成模式生成文件模板(参考 #3056 ， #2936 )

1.5b1

• #2432: 修正了变量参数和仅关键字参数之间不需要的*。多亏了亚历克斯·格伦霍尔姆。

• #3062: 无法使用1.5a2(未定义)构建PDF \hypersetup 对于日语文档，自 PR#3030 )

• 在HTML中更好地呈现多行签名。

• #777: LaTeX输出“嵌套太深”(参考文献 #3096 )

• 让 Latex 形象包含服从 scale 文本宽度适配之前(参考 #2865 ， #3059 )

• #3019: LaTeX在描述带参数的C函数时失败(参考 #3083 )

• 修复 Latex 内联文本，其中 < > - 狼吞虎咽地腾出一个空间

1.5决赛

• #3069: Even if 'babel' key is set to empty string, LaTeX output contains one \addto\captions...

• #3123: 用户 'babel' 不再遵守密钥设置

• #3155: 修复以下对象的JavaScript html_sourcelink_suffix IE和Opera失败

• #3085: 在破坏构建文档后保留当前目录。多亏了提摩太·坎皮克。

• #3181: Platex崩溃，部分包含Endash

• #3180: LaTeX：在连续的单行或多行CPP签名之间添加拉伸/收缩(参考 #3072 )

• #3128: 全局图像不支持.svgz文件

• #3015: 修复Windows上失败的测试。

• #1843: 修复具有自定义元类的描述符类的文档。多亏了埃里克·布雷。

• #3190: Util.plit_docinfo无法解析多行字段体

• #3024, #3037: 在Python3中，当无法将日志消息编码为控制台编码时，则会导致Applation.Sphinx._LOG崩溃。

测试

• 为了简化，Sphinx使用外部模拟包，即使 unittest.mock 是存在的。

1.4.9版（2016年11月23日发布）

修复错误

• #2936: 修复由于文档/MAN存在而无法构建MAN的文档/Makefile

• #3058: 在多个‘toctree’指令中使用相同的‘Caption’属性会导致警告/错误

• #3068: 允许在sphinx-Build.py的-D选项中使用‘=’字符

• #3074: add_source_parser() 在调试模式下崩溃

• #3135: sphinx.ext.autodoc 使用普通的Callable崩溃

• #3150: 修复了JavaScript中的查询词拆分器。它的行为与Python的正则表达式相同。

• #3093: GetText在替换图像上构建损坏。

• #3093: 下的图像节点上的GetText构建已损坏 note 指令。

• imgmath:如果图像生成失败，则显示错误消息时崩溃

• #3117: 如果告诫放在第一部分标题之前，Laex Writer就会崩溃

• #3164: Change search order of sphinx.ext.inheritance_diagram

1.4.8版（2016年10月1日发布）

修复错误

• #2996: Sphinx的轮包因ImportError而崩溃

1.4.7版（2016年10月1日发布）

修复错误

• #2890: QuickStart应在所有错误条件下一致返回错误

• #2870: 展平genindex列的高度。

• #2856: 在生成的HTML站点上搜索未找到某些符号

• #2882: 在链接检查中回退到状态为403的GET请求

• #2902: 如果关键字以下划线开头，则jsump p.ads无法加载搜索索引

• #2900: 修复epub内容.opf：将自动生成的孤立文件添加到脊柱。

• #2899: 修整 hasdoc() 函数在JJAA2模板中。它会检测到 genindex ， search 还有.。

• #2901: 修复epub结果：跳过创建从图像标记到原始图像文件的链接。

• #2917: 内联代码在HTML上用连字符连接

• #1462: 自动汇总警告具有尾随下划线的属性的命名元组

• 无法引用公式，如果 :nowrap: 指定的选项

• #2873: LaTeX中的代码块溢出(由于逗号)

• #1060, #2056: sphinx.ext.intersphinx: broken links are generated if relative paths are used in intersphinx_mapping

• #2931: 具有SAME：CAPTION：的代码块指令导致重复目标的警告。现在 code-block 和 literalinclude 不会自动使用标题定义超链接目标。

• #2962: LaTeX：长桌的标签缺失

• #2968: AUTODOC：显示继承选项中断文档字符串

1.4.6版（2016年8月20日发布）

不兼容的更改

• #2867: Linkcheck Builder在6-1.4的情况下崩溃。现在Sphinx依赖于Six-1.5或更高版本

修复错误

• AppleHelp:如果 hiutil 或 codesign 找不到命令

• 固定 make clean 当build dir包含常规文件（如 DS_Store .

• 减少epubcheck警告/错误：

  • 将doctype修复为html5

  • 将扩展名从.html更改为.xhtml。

  • 禁用EPUB结果的搜索页

• #2778: 在以下情况下修复AutoDoc崩溃 obj.__dict__ 是属性方法并引发异常

• 修复EPUB3输出中的重复TOC。

• #2775: 修复与不支持身份编码的服务器的链接检查失败

• #2833: 修复了在ext.Autodoc中设置实例批注格式的问题。

• #1911: -D 选项 sphinx-build 不会重写 extensions 变数

• #2789: sphinx.ext.intersphinx 如果给定库存，则生成错误的超链接

• 代码块标题的解析错误显示在文档中(参考： #2845 )

• #2846: singlehtml 构建器不包括地物编号

• #2816: 修复杂乱的构建中的数据 Domain.initial_data 类属性

1.4.5版（2016年7月13日发布）

不兼容的更改

• LaTeX，包含来自IMAGE指令的非内联图像会导致不连贯的空白，这取决于原始图像的宽度；在某些情况下，新的行为必然不同于以前的行为。(参考文献： #2672 )

• Latex 的用途 \includegraphics 引用sphinx自定义变量已被弃用；将来它将恢复为原来的laTex宏，自定义变量已具有备用名称。 \sphinxincludegraphics .

新增特征

• 新的配置选项 latex_keep_old_macro_names ，默认为 True 。如果 False ，允许宏(用于文本样式)仅使用 \sphinx -带前缀的名称

• LaTex Writer允许用户通过三个长度变量自定义“阴影”框（主题）。

• WEFF格式的Web字体文件现在由EPUB生成器支持。

修复错误

• jsdump fix for python 3：修复python>3上的HTML搜索

• #2676: (LaTeX)自Sphinx 1.4.4起字幕中的逐字文本错误

• #2629: 回忆录类崩溃 Latex 。修复者 latex_keep_old_macro_names=False (参考文献2675)

• #2684: sphinx.ext.intersphinx 以Six-1.4.1的成绩崩溃

• #2679: float 所需的程序包 'figure_align': 'H' LaTeX选项

• #2671: 图像指令可能会导致pdf中的间距不一致

• #2705: toctree 如果满足以下条件，则生成空的项目符号列表 :titlesonly: 指定

• #2479: sphinx.ext.viewcode 默认情况下使用python2高亮笔

• #2700: HtmlHelp构建器已硬编码index.html

• LaTex，因为1.4.4 inline文本后面跟着假空格

• #2722: C++，修复了变量/成员声明的id生成以包括命名空间。

• LaTeX、列表或引用块中的图像(来自IMAGE指令)不遵循缩进(与一起修复 #2671 )

• #2733: 从Sphinx 1.4.4开始 make latexpdf 生成大量超引用警告

• #2731: sphinx.ext.autodoc 不访问引发任何异常的属性方法

• #2666: C++，正确查找涉及构造函数的嵌套名称。

• #2579: Could not refer a label including both spaces and colons via sphinx.ext.intersphinx

• #2718: 如果文档文件不可读，Sphinx会崩溃

• #2699: 如果出现以下情况，帮助HTMLs中的超链接将断开 html_file_suffix 已设置

• #2723: 多行单元格输出的LaTeX pdf中的额外空格

• #2735: Latexpdf Underfull \hbox (badness 10000) 来自标题页的警告

• #2667: 如果调整大小的图像出现在部分标题中，则LaTeX崩溃

• #2763: (HTML)为必填项提供默认值 alt SVG源图像标签的属性，需要验证，现在与其他格式一致。

1.4.4版（2016年6月12日发布）

修复错误

• #2630: LaTeX：sphinx.sty注意环境格式问题

• #2632: 警告指令在报价环境LaTeX构建中失败

• #2633: Sphinx用旧的样式指数崩溃

• 修复一 \begin{{\minipage}} 1.4.2中的sphinx.sty的拼写错误（参考：68becb1）

• #2622: LaTeX在标题和目录后生成空页

• #2640: 1.4.2如果代码块位于WARNING指令内部，则LaTeX崩溃

• 让LaTeX也在内联代码中使用直引号(参考 #2627 )

• #2351: 如果将枚举列表放在脚注上，则LaTeX崩溃

• #2646: 如果数学包含两个空行，则LaTeX崩溃

• #2480: sphinx.ext.autodoc ：显示了内存地址

• LaTeX：允许代码块以最大嵌套深度出现在列表和引号内(参考 #777 ， #2624 ， #2651 )

• #2635: LaTeX代码指令根据观看分辨率生成不一致的帧

• #2639: Sphinx现在捆绑了iftex.tie

• 无法使用framed.sty 0.95生成PDF

• Sphinx现在捆绑需要的空间。

1.4.3版（2016年6月5日发布）

修复错误

• #2530: 如果警告中存在较大编号的脚注，则在构建PDF时出现“计数器太大”错误

• width 在以下情况下，Figure指令的选项不起作用 align 同时指定选项(参考： #2595 )

• #2590: 这个 inputenc 包中断在lualatex和xelatex下编译

• #2540: LaTeX头版上的日期使用不同字体

• 如果包含文档，则禁止显示“Document is Not Included in any toctree”(文档未包含在任何目录树中)警告(参考： #2603 )

• #2614: 如果用户在前导中设置非零parindent，则PDF输出中的某些表格将被移位

• #2602: URL redirection breaks the hyperlinks generated by sphinx.ext.intersphinx

• #2613: 如果加载合并的扩展模块，则显示警告

• #2619: 确保始终加载amstext LaTeX包(参考：d657225、488ee52、9d82cad和 #2615 )

• #2593: 如果表格中有任何图形，LaTeX会崩溃

1.4.2版（2016年5月29日发布）

新增特征

• 现在 suppress_warnings 接受以下配置(参考： #2451 ， #2466 )：

  • app.add_node

  • app.add_directive

  • app.add_role

  • app.add_generic_role

  • app.add_source_parser

  • image.data_uri

  • image.nonlocal_uri

• #2453: LaTeX Writer允许主题内容中的分页符；它们的水平范围现在适合线宽(在页边空白中带有阴影)。此外，警告型警告允许分页，其垂直间距已与提示型通知的垂直间距更一致(参考 #2446 )。

• #2459: LaTeX输出中文字代码块的框架(不仅是代码行本身)遵循列表或带引号的块中的缩进。

• #2343: 代码块中的长源码行在LaTeX输出(REF)中换行(不修改行号 #1534 ， #2304 )。

修复错误

• #2370: 在LaTeX Writer中，这些方程式略有错位

• #1817, #2077: 禁止对由Shinx-QuickStart生成的conf.py发出Pep8警告

• #2407: 如果文档包含大数据图像URI，则构建文档会崩溃

• #2436: Sphinx不按以下方式检查版本 needs_sphinx 如果加载扩展模块失败

• #2397: 设置土耳其语文档的缩写

• #2447: VerbatimBorderColor也错误地用于PDF的标题

• #2456: C++，修复了与文档合并相关的崩溃(例如，Singlehtml和Latex构建器)。

• #2446: LaTeX(Pdf)将本地目录(或更一般的主题节点)设置在牢不可破的框中，导致底部溢出

• #2476: 如果给定：nowrap：，则省略MathJax标记

• #2465: 如果没有为toctree指令提供标题选项，LaTeX构建器将失败

• 如果找到自引用目录树，则Sphinx崩溃

• #2481: Mecab搜索拆分器的拼写错误。多亏了佐藤直树。

• #2309: 修复程序无法通过引用角色引用“间接超链接目标”

• 如果映射URL包含任何端口，Intersphinx将失败

• #2088: 如果映射URL需要基本身份验证，则Intersphinx崩溃

• #2304: Latexpdf代码块中的自动换行符

• #1534: 在Latex逐字拼接块中换行很长

• #2460: PDF输出中标题文字块顶部的空白太多

• 加载多个数学扩展时显示错误原因(参考： #2499 )

• #2483: 如果图形标题仅包含非文本对象，则不会分配任何图形编号

• #2501: Unicode下标数字在LaTeX中归一化

• #2492: Figure指令With：FigWidth：生成错误的Latex代码

• 图的标题总是放在中间，即使 :align: 指定

• #2526: 如果区段仅包含图像，则LaTeX Writer崩溃

• #2522: Sphinx触及安装目录下的mo文件，导致权限错误。

• #2536: C++，修复了立即嵌套的作用域与当前作用域同名时的崩溃。

• #2555: 使用Unicode修复任何引用上的崩溃。

• #2517: 如果使用LuaLaTeX，则PDF中的书签编码错误

• #2521: 如果未找到SPHINX-BUILD，则生成的Makefile会导致BSD Make崩溃

• #2470: typing Backport包在使用Python2.7时导致自动对接错误

• sphinx.ext.intersphinx crashes if non-string value is used for key of intersphinx_mapping

• #2518: intersphinx_mapping 不允许使用非字母数字键

• #2558: 在DevHelp生成器上出现解包错误

• #2561: 当脚注包含链接时，信息构建器崩溃

• #2565: 生成的对象的描述 sphinx.ext.autosummary LaTeX写入器上的溢出行

• 将sphinx.sted中的pdflatex配置扩展到分段(参考： #2551 )

• #2445: rst_prolog 和 rst_epilog 对非休息源的影响

• #2576: sphinx.ext.imgmath 如果子进程引发错误，则崩溃

• #2577: sphinx.ext.imgmath ：将无效参数传递给dvisvgm

• #2556: Xapian搜索不适用于Python3

• #2581: 如果语言=“es”(西班牙语)，则搜索不起作用

• #2382: 在LaTeX Writer中调整图形数字缩写后的间距

• #2383: 生成的脚注由 latex_show_urls 溢出线

• #2497, #2552: 搜索按钮的标签不适合按钮本身

1.4.1版（2016年4月12日发布）

不兼容的更改

• 默认格式为 today_fmt 和 html_last_updated_fmt 再次回到strftime格式。Sphinx 1.5之前的版本还支持区域设置日期标记语言，以实现向后兼容。

翻译

• 加上威尔士语的翻译，多亏了杰拉特·帕尔默。

• 加上希腊语翻译，多亏了史泰里奥斯·维塔利斯。

• 感谢Dinu Gherman，增加了世界语翻译。

• 加上印地语翻译，多亏了珀南克H.古马利亚。

• 加上罗马尼亚翻译，感谢拉兹万·斯特凡内斯库。

修复错误

• 增加了支持 extern 和 thread_local .

• C++中，类型声明现在使用前缀 typedef ， using 和 type ，取决于声明的样式。

• #2413: C++，修复重复声明的崩溃

• #2394: Html_LAST_UPDATED_FMT无效时Sphinx崩溃

• #2408: 虚拟构建器在Makefile和Make.bat中不可用

• #2412: LaTeX构建器中的超链接目标已断开

• 图非段落项作为标题时指令崩溃

• #2418: TODAY_FMT中不再允许使用时间格式

• #2395: 如果图像文件名中包含Unicode字符，Sphinx将崩溃

• #2396: Genindex-Single中的“要解包的值太多”

• #2405: PDF中的Numref链接跳到错误位置

• #2414: 指向代码清单的PDF超链接中缺少数字

• #2440: Gmtime的导入错误。感谢乌韦·L·科恩。

1.4版（2016年3月28日发布）

不兼容的更改

• 跌落 PorterStemmer 包装支持。使用 PyStemmer 而不是 PorterStemmer 加速堵塞。

• sphinx_rtd_theme 已经变成了可选的。请手动安装。参考文献 #2087 ， #2086 ， #1845 和 #2097 。多亏了维克多·兹维罗维奇。

• #2231: 对于LaTeX编写器中的自定义角色，请使用DURole而不是DUspan。它允许将角色头衔作为自定义宏的参数。

• #2022: “Thumbs.db”和“.DS_Store”被添加到 exclude_patterns 将在sphinx-QuickStart上提供的conf.py中的默认值。

• #2027, #2208: 这个 html_title 仅接受字符串值。以及 None 无法接受值。

• sphinx.ext.graphviz ：默认情况下以内联方式显示图形图像

• #2060, #2224: 这个 manpage 角色现在生成 sphinx.addnodes.manpage 节点而非 sphinx.addnodes.literal_emphasis 节点。

• #2022: html_extra_path 还复制额外目录中的点文件，并引用 exclude_patterns 要排除额外文件和目录，请执行以下操作。

• #2300: 增强AutoClass：：以使用的文档字符串 __new__ 如果 __init__ 方法%s缺少或为空

• #2251: 以前，在词汇表指令下，一个定义的多个术语被转换为单个术语 term 节点和术语节点中的每个术语之间用 termsep 节点。在新的实现中，每个术语被转换为单独的 term 节点和 termsep 节点将被删除。通过这种更改，每个构建器的输出布局都略有改变。

• 默认的突出显示语言现在是python 3。这意味着源代码突出显示为python 3（它主要是python 2的超集），并且不尝试解析来区分有效代码。要恢复旧行为，请添加 highlight_language = "python" 承认。

• Locale Date Markup Language 喜欢 "MMMM dd, YYYY" 是的默认格式 today_fmt 和 html_last_updated_fmt 。然而，strftime格式如下 "%B %d, %Y" 对于Sphinx 1.5之前的版本，还支持向后兼容。较新的格式将从Sphinx 1.5中禁用。

• #2327: latex_use_parts 现在已被弃用。使用 latex_toplevel_sectioning 取而代之的是。

• #2337: 使用 \url{URL} 宏而不是 \href{URL}{URL} 在《 Latex 作家》里。

• #1498: 手册页编写器：如果定义列表中包含强节点，请不要将整个项目设置为粗体。

• #582: 从html输出的快速搜索框中删除提示消息。

• #2378: Sphinx现在捆绑了newflat.tie

新增特征

• #2092: 在拿破仑方案中添加TODO指令支持。

• #1962: 当从扩展添加指令、角色或节点时，如果这样的元素已经存在(内置的或由另一个扩展添加的)，则发出警告。

• #1909: 添加对Intersphinx库存的“文档”引用。

• C++类型别名支持（例如， .. type:: T = int ）

• 类、函数、类型别名和变量的C++模板支持 (#1729 ， #1314 )。

• 添加新的范围管理指令 namespace-push 和 namespace-pop .

• #1970: 用于导航下一个和上一个主题的键盘快捷键

• intersphinx：增加了使用http-basic-auth通过URL获取intersphinx库存的支持。

• C++在函数信息字段列表中添加了模板参数的支持。

• C++增加了对成员（函数）指针的支持。

• #2113: 允许 :class: 代码块指令的选项。

• #2192: Imgath(支持SVG的pngath)。

• #2200: 支持XeTeX和LuaTeX作为LaTeX构建器。

• #1906: 在可用于LaTeX输出的Colorbox中使用XCOLOR而不是COLOR。

• #2216: 纹理输入Makefile的改进。

• #2170: 支持中文搜索索引。

• #2214: 添加sphinx.ext.gihubages以在GitHub页面上发布文档

• #1030: 使LaTeX_Show_Pages的页面引用名称可翻译

• #2162: 添加Sphinx.add_source_parser()以添加扩展名中的源后缀和源解析程序

• #2207: 添加sphinx.parsers.Parser类；新解析器的基类

• #656: 增列 graphviz_dot 选项来切换 dot 命令

• #1939: 添加了 dummy Builder：不带输出的语法检查。

• #2230: 增列 math_number_all 对数学扩展中显示的所有数学进行编号的选项

• #2235: needs_sphinx 支持微版比

• #2282: 将“language”属性添加到“Basic”主题中的html标记

• #1779: 添加EPUB 3构建器

• #1751: 增列 todo_link_only 避免打开文件路径和行指示 todolist 。多亏了弗朗西斯科·蒙特萨诺。

• #2199: 使用 imagesize 用于获取图像大小的包。

• #1099: 将可配置的重试添加到链接检查生成器。多亏了亚历克斯·盖纳。也不要检查以开头的锚 ! 。

• #2300: 增强AutoClass：：以使用的文档字符串 __new__ 如果 __init__ 方法%s缺少或为空

• #1858: 添加Sphinx.Add_ENUMERABLE_NODE()，为Numfg功能添加可枚举节点

• #1286, #2099: 增列 sphinx.ext.autosectionlabel 扩展以允许引用部分使用其标题。多亏了塔格·奥希金斯。

• #1854: 允许选择Janome作为日式拆分器。

• #1853: 支持在html搜索上使用自定义文本拆分器 language='ja' 。

• #2320: 词汇表术语的分类器可用于索引条目分组关键字，该分类器也可用于翻译。另请参阅 术语表 。

• #2308: 定义 \tablecontinued 宏，以重新定义长表格的连续标签的样式。

• 如果多个图像是按相似性选择的，则选择一个图像 .. image:: filename.*

• #1921: Support figure substitutions by language and figure_language_filename

• #2245: 增列 latex_elements["passoptionstopackages"] 在前言的早期阶段调用PassOptionsToPackages的选项。

• #2340: 数学扩展：支持MathJax的多个方程对齐。

• #2338: 定义 \titleref 要重新定义其样式的宏 title-reference 角色。

• 定义 \menuselection 和 \accelerator 要重新定义其样式的宏 menuselection 角色。

• 定义 \crossref 用于重新定义引用样式的宏

• #2301: 经典html主题中的文本应该用连字符连接。

• #2355: 定义 \termref 要重新定义其样式的宏 term 角色。

• 添加 suppress_warnings 抑制任意警告消息（实验）

• #2229: 修复对于未知选项不给出警告

• #2327: 增列 latex_toplevel_sectioning 切换LaTeX文档的顶层切片。

修复错误

• #1913: C++，修复了次全局和全局范围内枚举数的断言错误。

• C++，将“签名char”和“unChar char”作为类型进行固定解析。

• C++，为“朋友”功能添加缺少的支持。

• C++，为虚拟基类添加缺少的支持（感谢Rapptz）。

• C++，为最终类添加支持。

• C++，对“EnUM”前缀类型进行固定解析。

• #2023: 荷兰语搜索支持使用丹麦语词干信息。

• C++，添加对用户定义文字的支持。

• #1804: 现在，html输出在侧边栏中包装溢出的长行文本。多亏了哈森·本·坦弗斯。

• #2183: 修复端口干燥器原因 make json 失败。

• #1899: 确保列表已发送到OptParse。

• #2164: 修复了对sphinx.sted内的pdftex的错误检查(针对graph icx包选项)。

• #2165, #2218: 从sphinx.sty中删除有缺陷的和不需要的条件。

• 如果给定未知语言，将生成修复中断的 Latex 代码

• #1944: 修复rst_prolog中断文件范围的元数据

• #2074: Make getText应该对.pot使用规范的相对路径。多亏了Anatoly Techtonik。

• #2311: 修复sphinx.ext.继承关系图引发AttributeError

• #2251: .rst文件中的换行符以错误的方式传输到.pot文件。

• #794: LaTeX输出中的固定日期格式未本地化

• 移除 image/gif 来自LaTeX编写器的Support_Image_Types (#2272 )

• 如果语言为空字符串，则引发fix-valueerror

• 当从生成的指令 Sphinx.add_crossref_type 使用

• 默认的突出显示语言现在是 default . 这意味着如果可能，源代码将突出显示为python 3（它主要是python 2的超集）。要恢复旧行为，请添加 highlight_language = "python" 承认。

• #2329: 如果源目录已更改，则强制刷新环境。

• #2331: 修复代码-块在DVI中由块填充；删除 xcdraw XCOLOR包中的选项

• 如果将Unicode提供给需要字符串值的confVal，则修复confVal类型检查器发出警告。

• #2360: LaTeX输出中的Fix Numref已损坏

• #2361: 修正“复合”指令中的其他段落缩进

• #2364: 修复Sphinx从旧版本升级时出现的KeyError‘rootSymbol’。

• #2348: 在LaTeX编写器上，将amsath和amssymb移到Fontpkg之前。

• #2368: 忽略emacs锁定文件，如 .#foo.rst 默认情况下。

• #2262: 在LaTeX输出中，文本块及其标题已用分页符分隔。

• #2319: 修改表计数器被LaTeX中的代码块覆盖。多亏了jfbu。

• 如果与第三方域扩展结合使用，修复解包警告。

• #1153: 修复侧边栏中的图形导致LaTeX构建错误。

• #2358: FIX User-Preamble无法覆盖TocDepth定义。

• #2358: 如果出现以下情况，则减少到深度 part 或 chapter 用于top_sectionLevel

• #2351: 固定脚注间距

• #2363: 修整 toctree() 在模板中生成SingleHTMLBuilder中的断开链接。

• #2366: 修复了在HTML生成器中的toctree上生成空超引用的问题。

文档

• #1757: 修复了使用 html_last_updated_fmt 。多亏了拉尔夫·海梅克。

1.3.6版（2016年2月29日发布）

新增特征

• #1873, #1876, #2278: 增列 page_source_suffix 超文本标记语言上下文变量。这应该通过以下方式介绍 source_parsers 特写。谢谢埃里克·霍尔舍尔。

修复错误

• #2265: Fix babel is used in spite of disabling it on latex_elements

• #2295: 避免在使用Python3自动停靠时枚举成员时出现突变字典错误

• #2291: 修复目录内脚注中的pdflatex“计数器太大”错误

• #2292: 修复了一些脚注从LaTeX输出中消失的问题

• #2287: sphinx.transforms.Locale 始终使用rst解析器。Sphinx i18n特性应该支持指定了SOURCE_PARSERS的解析器。

• #2290: 修整 sphinx.ext.mathbase 使用amsFonts可能会破坏用户对数学字体的选择

• #2324: 在命中递归限制时，打印如何增加递归限制的提示。

• #1565, #2229: 恢复新警告；新警告将从1.4版开始触发。

• #2329: 如果源目录已更改，则强制刷新环境。

• #2019: 修复搜索结果中的域对象不转义的问题

1.3.5版（2016年1月24日发布）

修复错误

• LaTex和Texinfo Builders的警告中未显示固定线号。

• 引用警告中未显示修复文件名

• LaTex和Texinfo Builders的警告中未显示固定线号。

• 索引警告中未显示修复行编号

• #2026: 修复了在解析文字包含链接时LaTeX构建器引发的错误

• #2243: 忽略类的奇怪文档字符串类型，不要崩溃

• #2247: 修整 #2205 分隔符使定义列表具有包含类似正则表达式的字符串的分类器的html

• #1565: 如果语法不正确，Sphinx现在将发出警告，指示已跳过突出显示 code-block ， literalinclude 诸若此类。

• #2211: 修复表格单元格中的段落在Latex输出中不起作用

• #2253: :pyobject: 选项 literalinclude 指令无法检测以空格或注释行开头的缩进主体块。

• 如果没有，则不显示FIX TOC :maxdepth: 对于目录树(参考： #771 )

• Fix warning message for :numref: if target is in orphaned doc (ref: #2244)

1.3.4版（2016年1月12日发布）

修复错误

• #2134: 使用引用修复插图标题导致LaTeX构建错误

• #2094: 修复带有参考的题目在LaTeX中不起作用

• #2147: LaTeX中的修复文本包含代码不会分页

• #1833: Fix email addresses is showed again if latex_show_urls is not None

• #2176: Sphinx.ext.graph viz：使用<Object>而不是<img>嵌入SVG

• #967: 修复SVG继承图没有超链接(可点击)

• #1237: 修复LaTeX中定义列表中不起作用的脚注

• #2168: FIX RAW指令不适用于文本编写器

• #2171: 修复程序无法将检查URL与Unicode链接

• #2182: LaTeX：支持1点以上的图像文件名

• #2189: 修复子目录中第一个文件的上一个同级链接使用最后一个文件，而不是从根目录树到树的上一个文件

• #2003: 修复以下情况下的解码错误(仅限于python2) make linkcheck 正在运行

• #2186: 修正数学中mathbb的 Latex 输出

• #1480, #2188: LaTeX：在章节标题中支持数学

• #2071: 修复两个以上章节标题中的相同脚注=>LaTeX/PDF Bug

• #2040: 修复当作者包含非ASCII字符时sphinx-apidoc中的UnicodeDecodeError

• #2193: 如果源目录和目标目录相同，则修复Shutil.SameFileError

• #2178: Fix unparsable C++ cross-reference when referencing a function with :cpp:any:

• #2206: 修复Sphinx LaTeX文档构建因脚注而失败

• #2201: 修复了超过30行的表格的错误表格标题

• #2213: 在经典主题中设置<BLOCKQUOTE>以适应<p>

• #1815: 如果warniserror设置为True并且链接断开，则修复链接检查不会引发异常

• #2197: 修复了缺少index.rst文件的略显隐晦的错误消息

• #1894: 快速入门Makefile中未列出的虚假目标

• #2125: 修复统一折叠字段的行为 (GroupedField 和 TypedField )

• #1408: 复制前检查LaTeX_LOGO有效性

• #771: 修复了LaTeX输出未设置为深度的问题

• #1820: 在Windows上，Colorama 0.3.3版不支持控制台配色。现在，Sphinx使用Colorama>=0.3.5来避免此问题。

• #2072: 修复章节中的脚注-标题不会显示在PDF输出中

• #1580: 修复长表中的段落在Latex输出中不起作用

• #1366: 修复居中图像在LaTeX中不居中的问题

• #1860: 使用以下命令修复手册页 :samp: 使用大括号-字体不会重置

• #1610: Sphinx在某些系统的日语索引中崩溃

• 如果mecab初始化失败，修复sphinx崩溃

• #2160: 如果部分包含图像，则修复PDF的损坏目录

• #2172: 修复功能失调的告诫 \py@lightbox 在Sphinx中。多亏了jfbu。

• #2198,`#2205 <https://github.com/sphinx-doc/sphinx/issues/2205>`_: make gettext 为定义列表生成损坏的消息ID。

• #2062: 在Python2中，文档测试中的转义字符被错误地处理。

• #2225: 如果选项不以破折号开头，则不执行链接的错误

• #2226: 当给定：nowrap：(jsath，mathjax)时，修复数学不是以HTML编码的

• #1601, #2220: “Any”角色违反了扩展域行为。受影响的扩展不支持RESOLE_ANY_XREF，RESOLE_XREF返回有问题的节点，而不是 None 。ShinxContrib-HTPDOMAIN就是其中之一。

• #2229: 修复对于未知选项不给出警告

1.3.3版（2015年12月2日发布）

修复错误

• #2177: 修复并行挂起

• #2012: 在以下情况下发生修复异常 numfig_format 是无效的

• #2142: 在中提供非缩小的JS代码 sphinx/search/non-minified-js/*.js 用于在PyPI上的源代码分发。

• #2148: 使用非ASCII文档构建DevHelp目标时出错。

1.3.2版（2015年11月29日发布）

新增特征

• #1935: 在LaTeX_ELEMENTS中使“numfigFormat”可重写。

修复错误

• #1976: 避免使用“2.0”版本的Babel，因为它不能在Windows环境下运行。

• 为兼容性添加“default.css”样式表（导入“classic.css”）。

• #1788: 当存在标题选项时，Graphviz扩展会引发异常。

• #1789: :pyobject: 选项 literalinclude 指令在类定义之后包括以下几行

• #1790: literalinclude 去掉头部和尾部的空行

• #1802: 当heme.conf将其用作‘Inherit’时，自动加载插件主题。多亏了平井隆幸。

• #1794: 扩展自定义主题 alabaster 或 sphinx_rtd_theme 找不到基本主题。

• #1834: Docutils 0.13的兼容性：docutils.io.FileInput原因TypeError的Handle_io_Errors关键字参数。

• #1823: “”作为sphinx-apidoc的<MODULE_PATH>会导致不友好的错误。现在‘’自动转换为绝对路径。

• 在设置不支持元数据的扩展时修复崩溃。

• #1784: Provide non-minified JS code in sphinx/search/non-minified-js/*.js

• #1822, #1892: 修复回归 #1061 。自Sphinx 1.3b3起，自动汇总无法为导入的成员生成文档。多亏了埃里克·拉尔森。

• #1793, #1819: “See Also”在文本输出中缺少换行符。多亏了平井隆幸。

• #1780, #1866: “Make Text”两次显示“CLASS”关键字。多亏了平井隆幸。

• #1871: 修复了具有一列和多行的表的LaTeX输出。

• 解决python 3.5中缺少htmlparserror异常的问题。

• #1949: 使用 safe_getattr 以避免使用具有自定义行为的描述符中止。

• #1915: 不要在单据字段类型注释中生成智能引号。

• #1796: 在py3上，自动化的.mo构建导致UnicodeDecodeError。

• #1923: 仅当巴别塔 Latex 元素为非空时才使用巴别塔功能。

• #1942: 修复WebSupport中的KeyError。

• #1903: 修复术语表术语的奇怪id生成。

• make text 如果定义列表项具有一个以上的分类器，则将压碎： term : classifier1 : classifier2 .

• #1855: 生成带有分类器的定义列表的损坏PO文件。

• #1869: 修复处理包含非ASCII字符的文件时出现的问题。多亏了马文·施密特。

• #1798: 修复标题中有引用的建筑 Latex 。

• #1725: 在PY2环境中，使用非ASCII字符进行doctest会导致 'ascii' codec can't decode byte 例外。

• #1540: 修复循环引用toctree的运行错误

• #1983: I18N转换功能中断使用节名称的引用。

• #1990: 将Toctree的标题用于LaTeX中内容的标题

• #1987: 在中忽略了修复与符号 :menuselection: 和 :guilabel: 浅谈 Latex 助剂

• #1994: 更多支持翻译的非标准解析器(如推荐标记解析器)和网络支持功能。现在，在Docutils转换期间，node.rawsource将返回到node.astext()。

• #1989: Windows上的“make blahblah”每次都会显示Sphinx的帮助消息。这是由于Sphinx 1.3.0/1.3.1生成的错误Make.bat造成的。

• 在py2环境中，由sphinx quickstart生成的conf.py应该具有“version”和“release”的前缀config值。

• #2102: 在Windows+Py3上，使用 |today| 而非ASCII日期格式将引发UnicodeEncodeError。

• #1974: UnundLocalError：使用时在赋值前引用局部变量‘DOMAIN’ any 角色和 sphinx.ext.intersphinx 在同一时间。

• #2121: 当单词在页面标题和页面内容上交叉时，多字搜索不会查找页面。

• #1884, #1885: 插件html主题不能继承另一个插件主题。多亏了铃木。

• #1818: sphinx.ext.todo 指令会将损坏的html类属性生成为‘Admonition-’ language 使用非ASCII语言区域指定，如‘ru’或‘ja’。要解决这个问题，现在 todo 指令可以使用 :class: 选择。

• #2140: 修复表中脚注在 Latex 中破裂的问题

• #2127: MecabBinder的html搜索功能不能在Python3上运行。这要归功于内田朋子。

1.3.1版（2015年3月17日发布）

修复错误

• #1769: 允许为不覆盖现有文件/目录的目标目录生成快速入门文件/目录。多亏了若山志郎。

• #1773: Sphinx-QuickStart不接受非ASCII字符作为选项参数。

• #1766: 消息“至少要运行Python2.6”充其量也是误导性的。

• #1772: 文档字符串中的交叉引用，如 :param .write: 破坏建筑。

• #1770, #1774: literalinclude 文件为空时发生异常。多亏了平井隆幸。

• #1777: Sphinx 1.3不能加载额外的主题。多亏了Tell-k

• #1776: source_suffix = ['.rst'] 在以前的版本上导致不友好的错误。

• #1771: 自动.mo生成不能正常工作。

• #1783: AutoDoc：Python2允许Unicode字符串进入 __all__ 。多亏了延斯·赫泽高·尼尔森。

• #1781: 设置 html_domain_indices 将引发类型检查警告。

1.3版（2015年3月10日发布）

不兼容的更改

• 角色 ref ， term 和 menusel 现在不要生成 emphasis 不再是节点。如果要保持斜体样式，请调整样式表。

• 角色 numref 使用 %s 作为表示数字位置的特殊字符 # 符号。

新增特征

• 将便利指令和角色添加到C++域：指令 cpp:var 作为的别名 cpp:member ，角色 :cpp:var 作为的别名 :cpp:member 、和角色 any 用于交叉引用任何C++声明操作。 #1577 ， #1744

• 这个 source_suffix 配置值现在可以是多个后缀的列表。

• 添加按源后缀指定源解析器的功能 source_parsers 配置值。

• #1675: 一个新的构建器AppleHelpBuilder已经加入，它可以构建Apple Help Books。

修复错误

• 1.3b3更改会中断先前包含重复msgid的gettext输出，例如“foo bar”和“1.3:foo bar中的版本更改”。

• #1745: 当脚注本身具有脚注标记时，LaTeX生成器会导致超出最大递归深度。

• #1748: 使用Python2.6时，sphinx/ext/iffig.py中存在语法错误。

• #1658, #1750: 如果选项不是以-、/或+开头，则不会创建链接(并给出警告)。多亏了平井隆幸。

• #1753: C++，添加了对更复杂声明的缺失支持。

• #1700: 增列 :caption: 选项 toctree 。

• #1742: :name: 选项提供给 toctree ， code-block 和 literalinclude 指令。

• #1756: 从1.3b3开始引入的搜索中的部分标题不正确。

• #1746: C++，修复了名称查找过程，并添加了声明中缺少的查找。

• #1765: C++，修复旧id生成以使用完全限定名称。

文档

• #1651: 增列 vartype Python域的字段描述。

版本1.3B3（2015年2月24日发布）

不兼容的更改

• 依赖关系要求更新：Docutils 0.11，Pygments 2.0

• 这个 gettext_enables 配置值已重命名为 gettext_additional_targets 。

• #1735: 使用https://docs.python.org/代替 http 协议。它被用来 sphinx.ext.intersphinx 和一些文件。

新增特征

• #1346: 添加新的默认主题；

  • 添加‘alabaster’主题。

  • 添加‘sphinx_rtd_heme’主题。

  • 默认的html主题已被重命名为经典主题。‘Default’仍然可用，但是它会发出一条建议，建议使用新的‘``alabaster`’主题。

• 补充 highlight_options 配置值。

• 这个 language 配置值现在在HTML模板中可用。

• 这个 env-updated 事件现在可以返回一个值，该值被解释为需要重写的附加文档名的ITerable。

• #772: 在C++中支持作用域和非作用域枚举。除枚举范围外，未限定范围的枚举中的枚举数还被注入父范围。

• 添加 todo_include_todos 配置选项以快速启动conf文件，按文档中所述进行处理。

• html breadcrumb items标签有“nav item”和“nav-item-n”类（如nav-item-0、1、2…）。

• 新选项 sphinx-quickstart --use-make-mode 用于生成使用Sphinx构建的生成模式的生成文件。

• #1235: I18N：如果设置为，则可以转换多个节点 gettext_additional_targets 在conf.py中。支持的节点包括：

  • “文字块”

  • “测试块”

  • “原始”

  • “图像”

• #1227: 增列 html_scaled_image_link Conf.py的配置选项，用于控制缩放的图像链接。

修复错误

• LaTex编写器现在为跨多行的单元格生成正确的标记。

• #1674: 如果模块的 __all__ 不是字符串列表。

• #1629: 使用VerbatimBorderColor将帧添加到LaTeX中的代码块

• 在Windows上，如果Sphinx被调用为 python sphinx-build.py 。

• #1687: LinkCheck现在将401个未经授权的响应视为“工作”。

• #1690: 目录树，包含 glob 选项现在还可以包含具有明确标题的单个文档的条目。

• #1591: C++元素的HTML搜索结果现在有了正确的页面间链接。

• BizStyle主题：嵌套的长标题页可以制作断开页面布局的长面包屑。

• BizStyle主题：在某些移动浏览器（iPhone5sSafari）上，所有面包屑条都成为“热门”。

• #1722: 还原 toctree() 在1.3b1中更改的模板函数行为。

• #1732: I18N：本地化的表标题引发异常。

• #1718: :numref: 不适用于标签中的大写字母

• #1630: 解决css冲突， div.container 文字块包装的css目标现已重命名为 div.literal-block-wrapper 。

• sphinx.util.pycompat 已恢复其向后兼容性；计划在Sphinx1.4中移除。

• #1719: Latex 作家不尊重 numref_format 标题中的选项

版本1.3B2（2014年12月5日发布）

不兼容的更改

• 为需要python 2.6或更高版本的setuptools-7.0更新bundled ez_setup.py。

新增特征

• #1597: 添加了从返回新模板名称的可能性 html-page-context 。

• PR#314, #1150: 现在检查配置值的类型。如果配置的值和默认值不具有相同的类型，并且不共享公共的非重要基类，则会引发警告。

修复错误

• PR#311: Sphinx-QuickStart在Python3.4上不起作用。

• 固定 autodoc_docstring_signature 不使用类docstring中的签名。

• 重新生成导致添加源文件时意外崩溃。

• #1607: 修复了使用“How to”类构建latexpdf时的崩溃

• #1251: 再修一次。深度低于：TocDepth：的部分不应显示在Localtoc侧栏上。

• 如果Sphinx是通过轮子包安装的，则使模式在Win32平台上不起作用。

1.3b1版（2014年10月10日发布）

不兼容的更改

• 放弃了对python 2.5、3.1和3.2的支持。

• 不再支持最高版本为0.9的Docutils。

• 移除 sphinx.ext.oldcmarkup 延伸。

• 不推荐使用的配置值 exclude_trees ， exclude_dirnames 和 unused_docs 已被删除。

• 一个新的节点， sphinx.addnodes.literal_strong 已添加，用于文本应以强字体逐字显示（即没有智能引号）。必须调整自定义编写器才能处理此节点。

• PR#269, #1476: 更换 <tt> 标签依据 <code> 。如果CSS包含某些样式，则应更新用户自定义样式表 tt> 标签。多亏了小宫武。

• #1543: templates_path 会自动添加到 exclude_patterns 以避免读取模板目录中的自动摘要rst模板。

• 自定义域应实现新的 Domain.resolve_any_xref 方法以使 any 角色正常工作。

• GetText构建器：默认情况下，getText不会向生成的POT文件发出UUID信息。请设置 True 至 gettext_uuid 以发出UUID信息。此外，如果 python-levenshtein 安装了第三方程序包，可以缩短计算时间。

• getText生成器：默认情况下禁用提取/应用“index”节点。请将“index”设置为 gettext_enables 启用提取索引项。

• PR#307: 在LaTeX中将帧添加到代码块中。多亏了小宫武。

新增特征

• 添加对python 3.4的支持。

• 添加对Docutils 0.12的支持

• 补充 sphinx.ext.napoleon 对numpy和google风格docstring支持的扩展。

• 添加了对源文件的并行读取(解析)的支持 sphinx-build -j 选择。第三方扩展将需要检查兼容性，如果它们将信息存储在构建环境对象中，则可能需要进行调整。看见 env-merge-info 。

• 添加了 any 角色，该角色可用于查找 any 输入 any 域。自定义域应实现新的 Domain.resolve_any_xref 方法以使其正常工作。

• 异常日志现在包含sphinx发出的最后10条消息。

• 添加了对扩展版本的支持(由返回的字符串 setup() ，这些可以在回溯日志文件中显示)。扩展模块的版本要求可以使用新的 needs_extensions 配置值。

• 使用更改文档中的默认角色 default-role 现在支持指令。

• PR#214: 添加了对14种语言的词干搜索支持，因此内置的文档搜索现在可以处理这些语言。感谢柴川义贵。

• PR#296, PR#303, #76: NUMFIG功能：为数字、表格和代码块分配数字。此功能配置为 numfig ， numfig_secnum_depth 和 numfig_format 。还有 numref 角色可用。多亏了小宫武。

• PR#202: 允许“。和“~”作为引用的前缀 :param: 用于Python的DOC字段。

• PR#184: 增列 autodoc_mock_imports ，允许模拟自动记录时不需要存在的外部模块的导入。

• #925: 允许在命令行上提供列表类型的配置值，如 -D key=val1,val2 。

• #668: 允许行编号为 code-block 和 literalinclude 指令以任意行号开始，并使用新的 lineno-start 选择。

• PR#172, PR#266: 这个 code-block 和 literalinclude 指令现在可以具有 caption 选项，该选项在输出中的代码前显示文件名。多亏了哈克先生、小宫武先生。

• 提示在Sphinx快速入门中输入文档语言。

• PR#217: 添加了配置值，以在生成的gettext目录中隐藏UUID和位置信息。

• PR#236, #1456: Apidoc：添加-M选项，将模块文档放在子模块文档之前。多亏了韦斯·特纳和吕克·萨弗雷。

• #1434: 为jquery.js和undercore.js提供非缩小的JS文件，以澄清缩小文件的来源。

• PR#252, #1291: Windows色彩控制台支持。多亏了我31岁。

• PR#255: 在生成LaTeX引用时，还要为节点上定义的ID插入LaTeX目标/锚点。多亏了奥利维尔·赫蒂埃。

• PR#229: 允许注册其他翻译人员。多亏了拉塞尔·西姆。

• 添加app.set_translator（）api以注册或重写docutils translator类，如 html_translator_class .

• PR#267, #1134: 将‘diff’参数添加到文本包含。多亏了理查德·沃尔和和歌山志郎。

• PR#272: 增加了‘bizstyle’主题。感谢熊谷昭二。

• 自动编译 *.mo 文件来自 *.po 文件时间： gettext_auto_build 是 True (默认)和 *.po 比 *.mo 文件。

• #623: sphinx.ext.viewcode 支持导入的函数/类别名。

• PR#275: sphinx.ext.intersphinx 支持多目标库存。多亏了布里吉塔·西普茨。

• PR#261: 添加了 env-before-read-docs 事件，该事件可以连接以在环境读取文档之前修改文档的顺序。

• #1284: 使用记录的计划选项 option 现在可以从 + 。

• PR#291: 的标题 code-block 被认为是裁判目标的头衔。多亏了小宫武。

• PR#298: 添加新接口： add_latex_package() 。多亏了小宫武。

• #1344: 添加 gettext_enables 要启用提取‘index’以获取文本目录输出/将翻译目录应用于生成的文档。

• PR#301, #1583: 允许指令的行编号 literalinclude 若要与包含的文件匹配，请使用新的 lineno-match 选择。多亏了杰佩·皮尔。

• PR#299: 将各种选项添加到Sphinx-快速入门。静音模式选项 --quiet 将跳过向导模式。多亏了若山志郎。

• #1623: 使用指定的返回类型 :rtype: 如果可能的话，现在都变成了链接。

修复错误

• #1438: 将jQuery版本从1.8.3更新到1.11.1。

• #1568: 修复当“居中”指令包含引用时发生的崩溃。

• 现在sphinx.ext.autodoc再次与python-2.5一起工作。

• #1563: add_search_language() 引发参数类型正确的AssertionError。多亏了里科曼。

• #1174: 修复在角色内部应用的智能报价，如 program 或 makevar 。

• PR#235: WebSupport的评论数据库架构缺少node_id字段的长度。多亏了独唱。

• #1466,`PR#241 <https://github.com/sphinx-doc/sphinx/issues/241>`_: 修复了CPP域解析器无法解析C+11“可变模板”声明的问题。多亏了维克多·兹维罗维奇。

• #1459,`PR#244 <https://github.com/sphinx-doc/sphinx/issues/244>`_: 修复缺省的mathjax js路径指向 http:// 这会在HTTPS服务器上导致混合内容错误。多亏了Sbrandtb和Robo9k。

• PR#157: AutoDoc从@Property修饰属性中删除虚假签名。多亏了大卫·哈姆。

• PR#159: 将覆盖目标添加到快速入门生成的Makefile和Make.bat。多亏了马蒂亚斯·特罗菲。

• #1251: 指定toctree：NUMBED：OPTION和：TOCDepth：METADATA时，深度大于 :tocdepth: 已经缩水了。

• PR#260: 在引文标签中为LaTeX输出编码下划线。多亏了伦纳特·弗里克。

• PR#264: 修复程序无法解析具有：名称：选项的地物节点的外部参照。多亏了小宫武。

• PR#265: FIX无法通过外部参照捕获GRAPVIZ节点的标题。多亏了小宫武。

• PR#263, #1013, #1103: 重写C++域。感谢雅各布·莱克·安德森。

  • 指向所有找到的嵌套名称和模板参数的超链接 (#1103 )。

  • 支持任何地方的函数类型，例如在std：：Function<bool(int，int)>中 (#1013 )。

  • 支持虚拟功能。

  • 将函数参数的解释更改为以下标准原型声明，即void f（arg）意味着arg是参数的类型，而不是名称。

  • 更新测试。

  • 更新了文档，详细描述了支持哪些声明以及命名空间声明如何影响声明和交叉引用查找。

  • 索引名称现在可能不同。元素按其完全限定名进行索引。改变这种行为应该相当容易，而且还可以通过名称空间/类进行索引。

• PR#258, #939: 为以下项添加保留选项 code-block 和 literalinclude 。多亏了扎法尔·西迪基。

• PR#268: 修复编号部分在Singlehtml模式下不起作用。它仍然是临时修复，因为存在节ID冲突的问题。多亏了小宫武。

• PR#273, #1536: 使用编号为圆形的Toctree修复运行错误。多亏了小宫武。

• PR#274: 如果URL出现在toctree中，则将其URL设置为默认标题值。多亏了小宫武。

• PR#276, #1381: rfc 和 pep 角色支持自定义链接文本。多亏了小宫武。

• PR#277, #1513: 参数列表中函数指针的高亮显示 c:function 。多亏了小宫武。

• PR#278: 如果已将toctree置于ONLY指令下，则FIX部分条目显示两次。多亏了小宫武。

• #1547: Pgen2记号赋值器无法识别 ... 字面值(省略号表示为py3)。

• PR#294: 在LaTeX生成器上，将浮动环境包装在写入文字块上，以避免标题和正文分离。多亏了小宫武。

• PR#295, #1520: make.bat latexpdf 机制，以 cd 返回到当前目录。多亏了彼得·萨特。

• PR#297, #1571: 将imgPath属性添加到所有构建器。这使得开发构建器扩展变得更容易。多亏了小宫武。

• #1584: 指向HTML“顶部”链接中的主文档。

• #1585: Sphinx 1.2.3中损坏的模块的自动摘要。

• #1610: 启用MeCab搜索选项且未安装python-mecab时，Sphinx会导致AttributeError。

• #1674: 如果模块的 __all__ 不是字符串列表。

• #1673: 使用修复崩溃 nitpick_ignore 和 :doc: 参考文献。

• #1686: Ifconfig指令不关心缺省配置值。

• #1642: 修复只有一个搜索结果出现在Chrome中。

文档

• 添加关于标记语法的说明。 (doc/markup/misc.rst ）

1.2.3版（2014年9月1日发布）

新增特征

• #1518: sphinx-apidoc Command现在有一个 --version 显示版本信息并退出的选项

• 新的地方：希伯来语，欧洲葡萄牙语，越南语。

修复错误

• #636: 在LaTeX版本中，在文字块中保留直接的单引号。

• #1419: 生成的I18N sphinx.js文件缺少来自‘.js_t’和‘.html’的消息目录项。该问题是从Sphinx 1.1引入的

• #1363: FIX I18N：缺少当前模块指令或当前类指令对python域的交叉引用。

• #1444: 自动汇总不会从属性文档字符串创建描述。

• #1457: 在python3环境中，当链接目标url具有散列部分时，使链接检查导致“无法将‘bytes’对象转换为隐式字符串”错误。多亏了豪尔赫·C。

• #1467: 如果自动方法指定了不存在的方法，则在Python3上发生异常

• #1441: 自动汇总无法正确处理嵌套类。

• #1499: 使用不可召回 setup 在conf.py中，现在的sphinx-Build会发出用户友好的错误消息。

• #1502: 在AutoDoc中，修复了包含反斜杠的参数默认值的显示。

• #1226: 自动文档、自动摘要：通过自动模块导入setup.py将调用安装过程并执行 sys.exit() 。现在，Sphinx避免了SystemExit异常并发出警告，而不会意外终止。

• #1503: PY：Function指令在使用空列表指定默认参数时生成不正确的签名 [] 。多亏了海尔特·詹森。

• #1508: 非ASCII文件名在生成Singlehtml、LaTeX、MAN、texInfo和Changes时引发异常。

• #1531: 在Python3环境中，General部分中带有‘SOURCE_LINK=TRUE’的docutils.conf会导致类型错误。

• PR#270, #1533: 当与继承图指令一起使用时，非ASCII文档字符串会导致UnicodeDecodeError。多亏了若山志郎。

• PR#281, PR#282, #1509: TODO扩展与WebSupport不兼容。多亏了小宫武。

• #1477: GetText不提取表或列表中的nodes.line。

• #1544: make text 当表格单元格为空时生成错误的表格。

• #1522: 表中的脚注在LaTeX中显示两次。从Sphinx 1.2.1开始，这个问题就出现了 #949 。

• #508: 每次从setup.py命令调用时，Sphinx都以零退出。前男友。 python setup.py build_sphinx -b doctest 即使doctest失败，也返回零。

1.2.2版（2014年3月2日发布）

修复错误

• PR#211: 在检查是否存在 html_logo 文件中，请检查完整的相对路径，而不是基本名称。

• PR#212: 使用自动对接和修复回溯 __init__ 不带文档字符串的方法。

• PR#213: 修复安装命令中缺失的导入。

• #1357: 选项名称由记录 option 现在再次允许不以破折号或斜杠开头，引用它们将正确工作。

• #1358: 修复了使用“通配符”样式引用时对源目录外部图像路径的处理。

• #1374: 修复了第一行不以句点结尾时自动摘要生成过长摘要的问题。

• #1383: 修复了phinx-apidoc与Python2.5的兼容性。

• #1391: 实际上禁止在Shinx-QuickStart中同时使用“pngath”和“mathjax”扩展名。

• #1386: 修复了阻止入口点机制添加多个主题的错误。

• #1370: 忽略文本编写器中的“toctree”节点，而不是引发。

• #1364: 修复‘..’时‘make getText’失败的问题Todolist：：‘指令存在。

• #1367: 安排一次更改 PR#96 这中断了sphinx.util.docfields.Field.make_field接口/行为 item 参数用法。

文档

• 扩展了 documentation about building extensions .

1.2.1版（2014年1月19日发布）

修复错误

• #1335: 修复带有感叹号前缀的自动摘要模板超载，如 {% extends "!autosummary/class.rst" %} 导致无限递归函数调用。这是由以下原因引起的 PR#181 。

• #1337: 使用修复自动对接 autoclass_content="both" 使用无用 object.__init__ 当类没有 __init__ 。这是由于更改了 #1138 。

• #1340: 无法在用Language=‘ja’生成的HTML快速搜索中搜索字母单词。

• #1319: 如果出现以下情况，请不要崩溃 html_logo 文件不存在。

• #603: 不要使用HTML化的标题来构建搜索索引(这会导致在标题中有文字的每个页面上都能找到“文字”)。

• #751: 通过使用Longtable，允许生产列表比LaTeX中的一页还长。

• #764: 在JS搜索中，始终寻找大小写较低的停用词。

• #814: AutoDoc：防止没有 __bases__ 。

• #932: AutoDoc：在以下情况下不会崩溃 __doc__ 不是字符串。

• #933: 如果发生故障，请不要崩溃 option 值格式不正确(包含空格，但不包含选项名称)。

• #908: 在Python3上，在pngath扩展中正确处理来自LaTeX的错误消息。

• #943: 在自动摘要中，如果“第一句”包含大写字母，则识别它们以从文档字符串中提取。

• #923: 在缓存pngath生成的图像时，请考虑整个LaTeX文档。这会在以下情况下正确地重新构建它们 pngmath_latex_preamble 改变。

• #901: 在未激活Sphinx数学扩展的情况下使用Docutils的新“数学”标记时发出警告。

• #845: 在代码块中，当选定的词法分析器失败时，仍会显示行号(如果已配置)。

• #929: 正确支持LaTeX输出中的解析文字块。

• #949: 更新装满Sphinx的tabulary.sty。

• #1050: 将匿名标签添加到 objects.inv 通过以下方式引用 intersphinx 。

• #1095: 修正了印刷媒体样式表总是包含在“滚动”主题中的问题。

• #1085: 修复了如果类描述具有 :noindex: 准备好了。

• #1181: 更优雅地报告AutoDoc指令中的选项错误。

• #1155: 修复了将C定义的方法自动记录为Python3中的属性的问题。

• #1233: 允许在intersphinx中查找具有“class”和“exc”角色的Python类和异常。

• #1198: 的“figWidth”选项允许使用“Image”。 figure 指令，由Docutils记录。

• #1152: 通过包含两个适用于Python2和3的语法版本，并为正在运行的Python版本加载适当的版本，修复了Python3代码的pycode解析错误。

• #1017: 帮助用户并告诉用户何时将参数 option 与所需格式不匹配。

• #1345: 使用修复两个错误 nitpick_ignore ；现在您不必删除商店环境即可使更改生效。

• #1072: 在JS搜索中，通过在词干之前对大写单词进行小写修复了搜索大小写单词的问题。

• #1299: 使行为成为 math 指令更加一致，避免在 Latex 输出中产生空环境。

• #1308: 在将“原始”节点的内容提供给搜索索引器之前，将其去掉。

• #1249: 修复了手册文档中重复的LaTeX页码。

• #1292: 在链路检查器中，当被HTTP 405拒绝时重试HEAD请求。还要使重定向代码更明显，并调整输出以使其更明显。

• #1285: 避免C域对象和节标题之间的名称冲突。

• #848: 在增量重新生成中始终使用最新的代码 sphinx.ext.viewcode 分机。

• #979, #1266: 修复中的排除处理 sphinx-apidoc 。

• #1302: 修复回归 sphinx.ext.inheritance_diagram 当记录不能被浸泡的类时。

• #1316: 删除硬编码 font-face 来自epub主题的资源。

• #1329: 修复了.po文件中空翻译msgstr的回溯问题。

• #1300: 修复在某些情况下无法在翻译的文档中使用的引用。

• #1283: 修复了在检测更改的文件时会尝试访问已删除文档的文档树的错误。

• #1330: 修整 exclude_patterns 中的子目录的行为 html_static_path 。

• #1323: 修复发射为空的问题 <ul> HTML编写器中的标记，这不是有效的HTML。

• #1147: 不要在“Singlehtml”构建器中显示侧边栏搜索框。

文档

• #1325: 增加了“星际Sphinx”教程部分。 (doc/tutorial.rst )

1.2版（2013年12月10日发布）

新增特征

• 补充 sphinx.version_info 用于编程检查sphinx版本的元组。

不兼容的更改

• 移除 sphinx.ext.refcounting 扩展——它是针对cpython的，在主分布中没有位置。

修复错误

• 恢复 versionmodified 用于versionAdded/Changed和Deprecated指令的CSS类。

• PR#181: 修整 html_theme_path = ['.'] 是始终重建所有文档的触发器(此更改将保留当前的“主题更改导致重建”功能)。

• #1296: 修复默认区域设置的HTML帮助生成的HTML文件中的无效字符集。

• PR#190: 修复getText不提取图形标题和其他块内的标题。多亏了迈克尔·施伦克。

• PR#176: 确保SETUP_COMMAND测试始终可以导入Sphinx。多亏了德米特里·沙赫涅夫。

• #1311: 修复C语言环境和Python3环境下的test_linkcode.test_html失败。

• #1269: 使用Python3.2或更高版本修复资源警告。

• #1138: 修复：何时 autodoc_docstring_signature = True 和 autoclass_content = 'init' 或 'both' ， __init__ 应从类文档中删除行。

1.2版beta3（2013年10月3日发布）

新增特征

• sphinx错误日志文件现在将包含加载的扩展名列表，以帮助调试。

不兼容的更改

• PR#154: 从LaTeX类名中删除“sphinx”前缀，但“sphinxmanual”和“sphinxhowto”除外。现在，您可以使用不带‘sphinx’前缀的定制文档类。多亏了埃里克·B。

修复错误

• #1265: FIX I18N：转换从命名目标指向的节名时崩溃。

• 一个错误的条件破坏了通常是index.rst的第一页的搜索功能。这一问题在1.2b1中介绍。

• #703: 当Sphinx无法解码包含非ASCII字符的文件名时，Sphinx现在会捕获UnicodeError，并在可能的情况下继续执行，而不是引发异常。

1.2版beta2（2013年9月17日发布）

新增特征

• apidoc 现在默认忽略“私有”模块，并有一个选项 -P 包括他们。

• apidoc 现在可以选择不为包和模块生成标题，因为模块docstring已经包含了一个rest标题。

• PR#161: apidoc 现在可以将每个模块写入独立页面，而不是将所有模块组合在一个页面上。

• Builders：在目录更新时重建i18n目标文档。

• 支持HTML编写器中的docutils.conf“writers”和“html4cs1 writer”部分。LaTex、Manpage和Texinfo的作者也支持各自的“作者”部分。

• 新的 html_extra_path 配置值允许指定包含应直接复制到HTML输出目录的文件的目录。

• 模块数据和属性的autoDoc指令现在支持 annotation 选项，以便可以覆盖数据/属性值的默认显示。

• PR#136: AutoDoc指令现在支持 imported-members 选项以包括从不同模块导入的成员。

• 新的地方：马其顿，僧伽罗，印度尼西亚。

• 使用SETUPTOOLS插件机制收集主题包。

不兼容的更改

• PR#144, #1182: 在GetText生成器生成的POT-Creation-Date上强制将时区偏移量设置为LocalTimeZone。感谢Masklinn和Jakub Wilk。

修复错误

• PR#132: 将jQuery版本更新为1.8.3。

• PR#141, #982: 避免了使用Python3编写PNG文件时崩溃。这要归功于Marin Wojdyr。

• PR#145: 在并行构建中，Sphinx丢弃第二个要写入的文档文件。多亏了TYOTICE。

• PR#151: 在LaTeX中对桌子进行了一些样式更新。

• PR#153: 现在可以覆盖“扩展”配置值。

• PR#155: 添加了对某些C++11函数限定符的支持。

• 修正：当模板包含utf-8编码字符串时，make gettext导致了unicodedecode错误。

• #828: 使用spect.getfullargSpec()能够在Python3上记录带有仅关键字参数的函数。

• #1090: FIX I18N：同一行中的多个交叉引用(术语、参考、文档)返回相同的链接。

• #1157: “global altoc.html”和隐藏的toctree的组合导致异常。

• #1159: 修复了为Python模块生成错误的对象清单，并在Intersphinx中添加了解决方法以修复受影响清单的处理。

• #1160: 缺少引用目标导致AssertionError。

• #1162, PR#139: Singlehtml生成器没有将图像复制到_Image/。

• #1173: 调整setup.py依赖项，因为JJIA2 2.7停止了与低于3.3和低于2.6的Python的兼容性。多亏了亚历山大·杜佩。

• #1185: 当一个Python模块声明了错误的编码或没有声明编码，并且包含非ASCII字符时，不要崩溃。

• #1188: 如果“Project Version”包含非ASCII字符，Sphinx-QuickStart会引发UnicodeEncodeError。

• #1189: “标题下划线太短”警告时，使用全角字符的“项目名称”在快速入门。

• #1190: 当在QuickStart的“Project Name”中使用非ASCII字符时，输出TeX/texinfo/man文件名没有基本名称(只有扩展名)。

• #1192: 修复手册页编写器中超链接的转义问题。

• #1193: FIX I18N：同一行中的多个链接引用返回相同的链接。

• #1176: 修正I18N：自动编号的命名脚注和自动符号脚注缺少脚注参考编号。

• PR#146,`#1172 <https://github.com/sphinx-doc/sphinx/issues/1172>`_: 修复并行构建中的ZeroDivisionError。多亏了TYOTICE。

• #1204: 修正了错误生成的指向本地Intersphinx目标的链接。

• #1206: 修复I18N：getText没有翻译警告指令的标题。

• #1232: Sphinx在Windows上生成了损坏的ePub文件。

• #1259: 在发出事件时保护调试输出调用；以防止任意对象的epr()实现导致构建失败。

• #1142: 修复Mac OS X上rst文件名的NFC/NFD标准化问题。

• #1234: 忽略字符串仅由空格字符组成。

1.2版beta1（2013年3月31日发布）

不兼容的更改

• 远离的 sphinx.util.compat.directive_dwim() 和 sphinx.roles.xfileref_role() 自1.0版以来已弃用。

• PR#122: 中给出的文件 latex_additional_files 现在覆盖Sphinx包含的TeX文件，例如 sphinx.sty 。

• PR#124: 由生成的节点 versionadded ， versionchanged 和 deprecated 指令现在包括所有添加的标记(如“版本X中的新标记”)作为子节点，并且编写器不需要生成额外的文本。

• PR#99: 这个 seealso 指令现在生成警告节点，而不是自定义 seealso 节点。

新增特征

• 标记

  • 这个 toctree 指令和 toctree() 模板函数现在有一个 includehidden 包括隐藏目录树条目(错误)的选项 #790 和 #1047 )。一只虫子在 maxdepth 选项，用于 toctree() 模板函数已修复(错误 #1046 )。

  • PR#99: 请参阅对正常告诫的指示。这消除了它们不寻常的css类(警告-请参阅-另见)、不一致的LaTeX警告标题(“请参阅”而不是“请参阅”)，以及文本构建器中的虚假缩进。

• HTML生成器

  • #783: 如果按宽度或高度缩放图像，则创建指向全尺寸图像的链接。

  • #1067: 改进了JavaScript搜索结果的排序：标题中的匹配出现在全文匹配之前，对象结果得到了更好的分类。还实现了一个可插拔的搜索记分器。

  • #1053: “右侧栏”和“可折叠侧栏”的HTML主题选项现在可以一起使用。

  • 更新至jquery 1.7.1和underline.js 1.3.1。

• 文本信息生成器

  • 当没有条目时，不再添加“索引”节点。

  • “deffn”类别如果包含大写字母，则不再大写。

  • desc_annotation 现在渲染节点。

  • strong 和 emphasis 现在节点的格式如下 literal 这是因为标准的texinfo标记 (*strong* 和 _emphasis_ ）由于通常使用这些构造来记录参数名，导致输出混淆。

  • 已对字段列表格式进行了调整，以便更好地显示“信息字段列表”。

  • system_message 和 problematic 现在，节点的格式化方式与文本生成器类似。

  • 选项指令签名中不再执行连字符的“en-dash”和“em-dash”转换。

  • @ref 现在使用而不是 @pxref 对于防止在链接前添加单词“see”的交叉引用（不影响信息输出）。

  • 这个 @finalout 已添加命令以获得更好的tex输出。

  • transition 现在，节点的格式是使用下划线（“uu”）而不是星号（“*”）。

  • 的默认值 paragraphindent 已从2更改为0，表示默认情况下段落不再缩进。

  • #1110: 新的配置值 texinfo_no_detailmenu 已添加，用于控制是否存在 @detailmenu 添加到“Top”节点的菜单中。

  • 除了“top”节点外，不再创建详细菜单。

  • 修复了重复域索引将导致无效输出的问题。

• Latex 生成器：

  • PR#115: 增列 'transition' 中的项目 latex_elements 用于自定义过渡的显示方式。多亏了杰夫·克鲁卡斯。

  • PR#114: LaTeX编写器现在默认包含“Cmap”包。这个 'cmappkg' 中的项目 latex_elements 可以用来控制这一点。多亏了德米特里·沙赫涅夫。

  • 这个 'fontpkg' 中的项目 latex_elements 现在默认为 '' 当 language 使用西里尔字母。由德米特里·沙赫涅夫建议。

  • 这个 latex_documents ， texinfo_documents ，以及 man_pages 配置值将被设置为基于 master_doc 如果没有在 conf.py 。以前，如果未设置这些值，则它们各自的构建器不会生成任何输出。

• 国际化：

  • 为自定义模板添加i18n功能。例如：doc目录中的sphinx参考文档提供了 sphinx.pot 包含来自的消息字符串的文件 doc/_templates/*.html 使用时 make gettext .

  • PR#61,`#703 <https://github.com/sphinx-doc/sphinx/issues/703>`_: 添加对非ASCII文件名处理的支持。

• 其他建筑商：

  • 添加了Docutils原生XML和伪XML构建器。看见 XMLBuilder 和 PseudoXMLBuilder 。

  • PR#45: 链接检查构建器现在可以检查 #anchor 为了生存而存在。

  • PR#123, #1106: 增列 epub_use_index 配置值。如果提供，将使用它而不是 html_use_index 给epub的建造者。

  • PR#126: 增列 epub_tocscope 配置值。该设置控制epub TOC的生成。用户现在还可以包括隐藏的TOC条目。

  • PR#112: 增列 epub_show_urls 配置值。

• 扩展：

  • PR#52: special_members 自动对接的标志现在的行为如下 members 。

  • PR#47: 增列 sphinx.ext.linkcode 分机。

  • PR#25: 在继承图中，类docstring的第一行现在是类的工具提示。

• 命令行接口：

  • PR#75: 增列 --follow-links 选择Sphinx-apidoc。

  • #869: Sphinx-Build现在具有以下选项 -T 用于在未处理的异常之后打印完整的回溯。

  • Sphinx现在支持标准 --help 和 --version 选项。

  • 当使用无效的选项或参数调用时，sphinx构建现在提供更具体的错误消息。

  • sphinx构建现在有一个详细选项 -v 可以重复使用以获得更大的效果。一次出现会比正常情况下提供稍微更详细的输出。此选项出现两次或两次以上可提供更详细的输出，这些输出可能对调试有用。

• 场所：

  • PR#74: 修改一些俄语翻译。

  • PR#54: 增加了挪威语Bokmaal的翻译。

  • PR#35: 增加了斯洛伐克语翻译。

  • PR#28: 增加了匈牙利语翻译。

  • #1113: 添加希伯来语区域设置。

  • #1097: 添加巴斯克地区。

  • #1037: 修复波兰语翻译中的拼写错误。感谢雅各布·威尔克。

  • #1012: 更新爱沙尼亚语翻译。

• 优化：

  • 通过缓存词干例程的结果来加速构建搜索索引。在构建python文档时节省大约20秒。

  • PR#108: 为并行建筑添加新的实验支持 sphinx-build -j 选择。

文档

• PR#88: 增加了“Sphinx开发人员指南” (doc/devguide.rst )，概述了Sphinx项目的基本开发过程。

• 添加了详细的“安装Sphinx”文档 (doc/install.rst ）

修复错误

• PR#124: 如果没有悬空段落，修改版本中的固定段落将被忽略。修复错误的html输出(嵌套 <p> 标签)。FIX VersionModify不可翻译。多亏了金子。

• PR#111: 即使在设置了继承成员的情况下，也要遵守Add_Autodocattrgetter()。感谢A·杰西·吉鲁·戴维斯。

• PR#97: 修复翻译文档中的脚注处理。

• 修复文本编写器不处理图指令内容的访问u图例。

• 修复不考虑宽/全宽字符的文本生成器：标题下划线宽度、表布局宽度和文本换行宽度。

• 修复 Latex 表标题单元格中的前导空格。

• #1132: 修复第一列中多行单元格的LaTeX表格输出。

• #1128: 修复尝试使用非标准区域设置格式化时间字符串时出现的Unicode错误。

• #1127: 修复了AutoDoc尝试标记化非Python文件时的回溯。

• #1126: 修复错误位置的双连字符到短划线的转换，例如LaTeX中的命令行选项名称。

• #1123: 允许在指定给的文件名中使用空格 literalinclude 。

• #1120: 增加了关于i18n的改进，包括Sphinx内置的“Basic”、“haiku”和“Scrols”主题。感谢莱昂纳多·J·卡巴列罗·G。

• #1118: 更新了西班牙语翻译。感谢莱昂纳多·J·卡巴列罗·G。

• #1117: 在sphinx-apidoc中处理.pyx文件。

• #1112: 当以不同方式(绝对/相对)从文档引用时，避免重复下载文件。

• #1111: 修复在以下情况下无法在搜索中查找大写单词的问题 html_search_language 是“ja”。多亏了斋藤友友。

• #1108: 文本编写器现在使用非默认起始值(基于Ewan Edwards的补丁)正确地对枚举列表进行编号。

• #1102: 支持AutoDoc中的多上下文“with”语句。

• #1090: 修正了GetText无法提取术语表术语的问题。

• #1074: 将环境版本信息添加到生成的搜索索引，以避免与旧版本的兼容性问题。

• #1070: 避免在运行Python3时出现非酸洗问题，保存的环境是在Python2下创建的。

• #1069: 修复了AutoDoc尝试格式化不带关键字参数的“Partial”函数的签名时导致的错误(Artu Gaspar打的补丁)。

• #1062: 使用sphinx.ext.audoc. __init__ 类签名的方法签名。

• #1055: 修复了Web支持与源目录的相对路径。

• #1043: 修复Sphinx-快速入门再次询问是/否问题，因为 input() 在Python3.2.0+Windows上返回带有额外‘r’的值。多亏了雷吉斯·德坎普。

• #1041: 修复CPP域解析器无法使用修饰符解析常量类型的问题。

• #1038: 修复了CPP域解析器无法解析C+11“静态常量表达式”声明的问题。感谢雅各布·威尔克。

• #1029: 修复了如果映射使用Python3.3设置了多个键/值，intersphinx_maping值不稳定的问题。

• #1028: 修复文本生成器中的行块输出。

• #1024: 如果找不到Sphinx，则改进Makefile/Make.bat错误消息。多亏了Anatoly Techtonik。

• #1018: 修复了文本生成器中的“CONTAINER”指令处理。

• #1015: 停止重写Java脚本中的jQuery contains()。

• #1010: 默认情况下，使pngath图像透明；IE7+应该可以处理它。

• #1008: 使用Python3.3修复测试失败。

• #995: 修正了LaTeX“HOWTO”课程的目录和页码。

• #976: FIX getText不提取索引项。

• PR#72: #975 ：修复了Docutils 0.10之前未提取定义术语的getText。

• #961: 修复代码片段中三引号的LaTeX输出。

• #958: 不保留 environment.pickle 在失败的构建之后。

• #955: 修复I18N转换。

• #940: 修正GetText不能提取图形标题。

• #920: 修复允许导入的PIL包装问题 Image 没有PIL命名空间。多亏了马克·施莱希。

• #723: 修复了基于WebKit的浏览器中本地文件的搜索功能。

• #440: 修复了某些文件系统中生成错误过时文件列表的粗略时间戳解析。

1.1.3版（2012年3月10日）

• PR#40: 修整 safe_repr 函数以正确解码包含非ASCII字符的字节字符串。

• PR#37: 允许通过以下方式配置sphinx-apidoc SPHINX_APIDOC_OPTIONS 。

• PR#34: 恢复与Python2.4的兼容性。

• PR#36: 在特定于Document类的LaTeX输出中修复“书目到目录”。

• #695: 当显式指定突出显示语言“python”时，不要试图通过解析代码来识别非Python代码段。

• #859: 修复在某些情况下找不到要链接的适当对象时出现的异常。

• #860: 遇到无效的文档测试示例时不要崩溃，只需发出警告即可。

• #864: 使用以下一些设置修复崩溃 modindex_common_prefix 。

• #862: 修复处理 -D 和 -A Python3上的选项。

• #851: 识别并警告循环目录树，而不是遇到递归错误。

• #853: 恢复与Docutils主干的兼容性。

• #852: 再次修复HtmlHelp索引项链接。

• #854: 修复了继承图在内置中引发属性错误的问题。

• #832: 修复在词汇表中添加注释或单独术语时发生的崩溃。

• #834, #818: 修复Sphinx支持的所有语言的HTML帮助语言/编码映射。

• #844: 修复了在doctest扩展中处理Unicode输出时的崩溃。

• #831: 提供 --project Setup_Command中通告的标志。

• #875: 修复了在Python3下读取配置文件的问题。

• #876: 修复了Python3下的快速入门测试。

• #870: 修复删除文档时出现的虚假KeyError。

• #892: 修改子目录中的主文档中单一的HTML构建器的错误行为。

• #873: 使用Empty修复断言错误 only 指令。

• #816: 修复Qt帮助构建器中的编码问题。

版本1.1.2（2011年11月1日）--1.1.1无论如何都是一个愚蠢的版本号！

• #809: 在源代码发行版中包含自定义修复程序。

版本1.1.1（2011年11月1日）

• #791: 修复QtHelp、DevHelp和HtmlHelp索引项链接。

• #792: 在源代码分发中包含“sphinx-apidoc”。

• #797: 不要在格式错误的词汇表上崩溃。

• #801: 使Intersphinx在没有SSL支持的情况下正常工作。

• #805: 使之成为 Sphinx.add_index_to_domain 方法正常工作。

• #780: 修复了与Python2.5的兼容性。

1.1版（2011年10月9日）

不兼容的更改

• 这个 py:module 指令不会输出其 platform 期权价值再也没有了。(这是该指令唯一输出的内容，因此非常不一致。)

• 删除了对旧依赖项版本的支持；现在要求是：

  • Pygices＞1.2

  • DOCUTILLS＞0.7

  • JICAN2>＝2.3

新增特征

• 增加了对python 3.x的支持。

• 新的建设者和子系统：

  • 添加了一个Texinfo生成器。

  • 增加了对内容的i18n支持，a gettext 建筑商和相关公用设施。

  • 增加了 websupport 类库和建筑商。

  • #98: 添加了一个 sphinx-apidoc 自动生成源文件层次结构的脚本，其中包含用于记录模块和包的AutoDoc指令。

  • #273: 添加用于添加对英语以外语言的全文搜索支持的API。添加对日语的支持。

• Markup：

  • #138: 添加了一个 index 角色，以创建内联索引项。

  • #454: 添加了更多的索引标记功能：标记See/See Also条目和给定键的Main条目。

  • #460: 属性来限制HTML节号的深度。 toctree ‘的 numbered 选择。

  • #586: 实施情况得到改进 glossary 允许每个定义有多个术语的标记。

  • #478: 增列 py:decorator 指令来描述装饰者。

  • C++域现在支持数组定义。

  • C++域现在支持DOC字段 (:param x: 内部指令）。

  • 章节标题 only 指令现在得到正确处理。

  • 补充 emphasize-lines 源代码指令的选项。

  • #678: C++域现在支持超类。

• HTML建设者：

  • 补充 pyramid 主题。

  • #559: html_add_permalinks 现在是一个字符串，提供要以固定链接显示的文本。

  • #259: 现在，HTML表格行有偶数/奇数个CSS类来启用“斑马样式”。

  • #554: 添加主题选项 sidebarwidth 切入基本主题。

• 其他建筑商：

  • #516: 增加了新的价值 latex_show_urls 选项以在脚注中显示URL。

  • #209: 增列 text_newlines 和 text_sectionchars 配置值。

  • 增列 man_show_urls 配置值。

  • #472: 链接检查构建器：并行检查链接，使用HTTP Head请求，并允许配置超时。新配置值： linkcheck_timeout 和 linkcheck_workers 。

  • #521: 增列 linkcheck_ignore 配置值。

  • #28: 在LaTeX构建器中支持表中的行/列跨距。

• 配置和可扩展性：

  • #537: 增列 nitpick_ignore 。

  • #306: 增列 env-get-outdated 事件。

  • Application.add_stylesheet() 现在接受完整的URI。

• Autodoc：

  • #564: 增列 autodoc_docstring_signature 。启用时(默认设置)，如果在文档字符串的第一行找到签名，则AutoDoc将从该行检索签名。

  • #176: 提供 private-members AutoDoc指令的选项。

  • #520: 提供 special-members AutoDoc指令的选项。

  • #431: 属性的文档注释现在可以与分配在同一行上给出。

  • #437: AUTODOC现在显示类数据属性值。

  • AutoDoc现在支持记录 functools.partial 物体。

• 其他扩展名：

  • 增加了 sphinx.ext.mathjax 延伸。

  • #443: 允许引用外部图形文件。

  • 补充 inline 选择graphviz指令，并修复了 Latex 输出中的默认（块样式）。

  • #590: 增列 caption GRAPHVIZ指令的选项。

  • #553: 增列 testcleanup Doctest扩展中的块。

  • #594: trim_doctest_flags 现在还删除了 <BLANKLINE> 指标。

  • #367: 添加了自动排除继承关系图中的隐藏成员，以及有选择地启用它的选项。

  • 补充 pngmath_add_tooltips .

  • Math扩展名DisplayMath指令现在支持 name 除了 label 用于给出方程式标签，与docutils兼容。

• 新场所：

  • #221: 添加了瑞典语区域设置。

  • #526: 添加了伊朗语言环境。

  • #694: 添加了拉脱维亚语区域设置。

  • 添加了尼泊尔地区。

  • #714: 添加了韩语区域设置。

  • #766: 添加了爱沙尼亚语区域设置。

• 修复错误：

  • #778: 修复通过搜索链接的页面上的“隐藏搜索匹配”链接。

  • 修复“viewcode”扩展引用的源位置。

1.0.8版（2011年9月23日）

• #627: 修复自动摘要生成中的AttributeError回溯。

• 修复 abbr 当缩写中有换行符时的角色。

• #727: 修复指向具有自定义对象类型的搜索结果的链接。

• #648: 修复有关未定义参照的警告中报告的行号。

• #696, #666: 修复不是类型名称的C++数组定义和模板参数。

• #633: 在LaTeX输出中允许在章节页眉中有脚注。

• #616: 允许通过intersphinx链接关键字。

• #613: 允许在生产列表令牌名称中使用Unicode字符。

• #720: 为文本和MAN的Graphviz节点添加虚拟访问者。

• #704: 修复图像文件复制错误。

• #677: 修复了C++域中多个签名的解析。

• #637: 查找源文件时忽略Emacs锁定文件。

• #544: 允许AutoDoc中的可导入模块使用.pyw扩展名。

• #700: 使用 $(MAKE) 在快速入门生成的Makefile中。

• #734: 使侧边栏搜索框宽度在浏览器中保持一致。

• #644: 固定HTML输出中居中图形的间距。

• #767: 将SphinxError消息打印到sys.stderr时对其进行安全编码。

• #611: 修复了没有章节但有链接目标的文档的LaTeX输出错误。

• 正确地将内置方法描述符视为AutoDoc中的方法。

• #706: 不要再胡乱拼凑Python的textwrap模块。

• #657: ViewCode现在可以正确处理使用非ASCII编码的源文件。

• #669: 尊重 noindex Py：模块指令中的标志选项。

• #675: 修复包含不存在的行时出现的索引错误 literalinclude 。

• #676: 遵守自定义函数/方法参数分隔符字符串。

• #682: 修复JS与jQuery>=1.5的不兼容。

• #693: 修复了编写HTMLHelp.hhk文件时出现的双重编码问题。

• #647: 不要在已分析的文本块中应用智能类型分析器。

• C++域现在支持数组定义。

1.0.7版（2011年1月15日）

• #347: 修复了自动汇总中静态方法指令的错误生成。

• #599: 将PIL导入为 from PIL import Image 。

• #558: 修复LaTeX输出中带有字幕的长表。

• 使令牌引用在LaTex输出中再次作为超链接工作。

• #572: 当找不到引用标签时，默认情况下显示警告。

• #536: 在挑剔模式下抱怨缺少参考目标时，包括行号。

• #590: 修复了LaTeX输出中图形图表的内联显示。

• #589: 在安装命令中使用app.Build()进行构建。

• 修复继承关系图异常中的错误，如果其中一个是内置的，则会跳过基类。

• 为C++域对象修复通用索引链接。

• #332: 使LaTeX输出中的警告边界可见。

• #573: 修复删除文件后重建时发生的KeyError错误。

• 修复删除带有全局目录树的文件时的回溯。

• 如果无法导入AutoDoc对象，则在下次生成时始终重新读取包含该指令的文档。

• 如果无法导入AutoDoc对象，请显示导入错误的完整回溯。

• 修复一个没有注意到删除下载文件和图像的错误。

• #571: 实施 ~ C域的交叉引用前缀。

• 固定胶乳产量的回归 #556 。

• #568: 修复了在描述符上查找类属性文档的问题，现在可以使用注释文档。

• 修复跟踪 only 前面有目标的指令。

• 修复重复的C++域对象发生的回溯。

• 修复到对象的javascript域链接 $ 以他们的名义。

1.0.6版（2011年1月4日）

• #581: 修复空交叉引用目标的Python域中的回溯。

• #283: 修复了Chrome浏览器上的文字块显示问题。

• #383, #148: 支持对常规索引和词汇表中有限范围的重音字符进行排序。

• #570: 试着解码 -D 和 -A 使用区域设置的首选编码的命令行参数。

• #528: 观察 locale_dirs 在查找JS翻译文件时。

• #574: 在LaTeX构建器中添加特殊代码，以便更好地支持日语文档。

• 回归 #77 ：如果只有一个使用指定的参数 :param: 标记，项目符号列表现在再次被抑制。

• #556: 修复在某些情况下LaTeX输出中缺失的段落分隔符。

• #567: 发射出 autodoc-process-docstring 事件，即使对于没有文档字符串以便可以添加内容的对象也是如此。

• #565: 在LaTeX构建器中，不仅文字块需要不同的表处理，而且还有相当多的其他类似列表的块元素。

• #515: 修复没有有效签名的Python对象的视图代码扩展中的回溯。

• 修复了从自动文档包含的文档字符串生成的警告的行号奇怪报告，这是由于不同的Docutils版本导致的。

• C++域的几种修复方法。

1.0.5版（2010年11月12日）

• #557: 为对齐的图像和插图添加Docutils 0.7所需的CSS样式。

• 在由LaTex输出生成的makefile中，不要在clean上删除PDF文件；它们可能是必需的图像。

• #535: 修复为线条块生成的 Latex 输出。

• #544: 允许 .pyw 作为源文件扩展名。

1.0.4版（2010年9月17日）

• #524: 在Windows上以二进制模式打开Intersphinx清单，因为版本2包含zlib压缩数据。

• #513: 允许为JavaScript文件提供非本地URI，例如在JSMath扩展名中。

• #512: 修复以下情况下的回溯 intersphinx_mapping 是空的。

1.0.3版（2010年8月23日）

• #495: 修复来自Docutils目录的链接的内部链接与外部链接的区别。

• #494: 解决这个问题 maxdepth 选项，用于 toctree() 与一起使用时可调用的模板 collapse=True 。

• #507: 修复了在字符串文字中包含方括号的Python参数列表解析崩溃的问题。

• #501: 修正了在用没有字幕的图形构建LaTeX文档时的回归问题。

• #510: 修复不可拾取的类的继承图。

• #497: 为侧边栏折叠按钮引入单独的背景颜色，使其更易于查看。

• #502, #503, #496: 修复了几个内置主题中的小布局错误。

1.0.2版（2010年8月14日）

• #490: 修复对由 add_object_type() 接口函数。

• 修复对不同指令类型的文档字段类型的处理。

• 允许打破长签名，继续与反弹逃脱新线。

• 修复不需要的C域引用样式（因为命名空间与Pygments样式冲突）。

• 允许使用显式锚定引用PEP和RFC。

• #471: 修复对图形的LaTeX引用。

• #482: 在执行非精确搜索时，请仅匹配给定类型的对象。

• #481: 使用以下命令应用非精确搜索以查找Python引用目标 .name 对于模块也是如此。

• #484: 修复了复制信息字段列表中的参数时崩溃的问题。

• #487: 修复了将默认角色设置为由 oldcmarkup 分机。

• #488: 修复了安装json-py时的崩溃，它提供了一个 json 模块，但与Simplejson不兼容。

• #480: 修正了Intersphinx中目标命名的处理。

• #486: 修复删除 ! 适用于所有交叉引用角色。

版本1.0.1（2010年7月27日）

• #470: 修复为REST域对象生成的目标名称；它们不在同一命名空间中。

• #266: 增加孟加拉语。

• #473: 修复了解析JavaScript对象名称时的错误。

• #474: 当没有toctree时，使用SingleHTMLBuilder修复构建。

• 修复Interspinx与显式目标链接的对象的显示名称。

• 用JSON构建器修复建筑。

• 修复 Latex 对象描述中的超引用。

版本1.0（2010年7月23日）

不兼容的更改

• 已添加对域的支持。域是指令和角色的集合，所有这些指令和角色都描述属于一起的对象，例如编程语言的元素。提供了一些内置域：

  • Python

  • C

  • C++

  • JavaScript

  • reStructuredText

• 用于定义和链接到C指令的旧标记现在已弃用。如果不激活，它在未来版本中将不再起作用 oldcmarkup 扩展；在Sphinx 1.0中，它默认处于激活状态。

• 删除了对旧依赖项版本的支持；现在要求是：

  • Docutils>=0.5

  • JICAN2>＝2.2

• 删除了不推荐使用的元素：

  • exclude_dirs 配置值

  • sphinx.builder 模块

新增特征

• 一般：

  • 添加了一个“挑剔”模式，对所有丢失的引用发出警告。它被激活 sphinx-build -n 命令行开关或 nitpicky 配置值。

  • 补充 latexpdf 快速启动生成文件中的目标。

• Markup：

  • 这个 menuselection 和 guilabel 角色现在支持与符号加速器。

  • 现在可以识别新的更紧凑的文档字段语法： :param type name: description .

  • 增列 tab-width 选项以 literalinclude 指令。

  • 补充 titlesonly 选择权 toctree 指令。

  • 添加了 prepend 和 append 选项添加到 literalinclude 指令。

  • #284: 现在，所有的docinfo元数据都被放入文档元数据中，而不仅仅是作者。

  • 这个 ref 角色现在还可以按标题引用表格。

  • 这个 include 指令现在支持绝对路径，它被解释为相对于源目录的路径。

  • 在python域中，引用如下 :func:`.name `如果找不到直接匹配，请查找具有任何前缀的匹配名称。

• 配置：

  • 增列 rst_prolog 配置值。

  • 增列 html_secnumber_suffix 用于控制节编号格式的配置值。

  • 增列 html_compact_lists 用于控制Docutils的精简列表功能的配置值。

  • 这个 html_sidebars 配置值现在可以包含模式作为键，值可以是显式选择应该呈现哪些侧栏模板的列表。这意味着内置侧边栏内容只能有选择地包含。

  • html_static_path 现在可以包含单个文件条目。

  • 新的通用配置值 exclude_patterns 使旧的 unused_docs ， exclude_trees 和 exclude_dirnames 已经过时了。

  • 增列 html_output_encoding 配置值。

  • 添加了 latex_docclass 配置值，并使“Twoside”文档类选项可由“One Side”覆盖。

  • 添加了 trim_doctest_flags 配置值，默认情况下为真。

  • 增列 html_show_copyright 配置值。

  • 增列 latex_show_pagerefs 和 ``latex_show_urls` 配置值。

  • 的行为 html_file_suffix 略有更改：空字符串现在表示“无后缀”而不是“默认后缀”，请使用 ``None` 表示“默认后缀”。

• New builders：

  • 添加了EPUB格式的生成器。

  • 添加了用于手动页面的生成器。

  • 添加了单个文件HTML生成器。

• HTML输出：

  • 内联角色现在得到一个带有其名称的CSS类，允许样式自定义其外观。特定于域的角色有两个类， domain 和 domain-rolename .

  • 引用现在获取类 internal 如果它们是整个项目的内部，而不是当前页面的内部。

  • 外部引用的样式可以与新的 externalrefs 默认主题的主题选项。

  • 在默认主题中，边栏现在可以通过使用新的 collapsiblesidebar 主题选项。

  • #129: Toctree现在包装在一个 div 使用类标记 toctree-wrapper 在HTML输出中。

  • 这个 toctree 模板中的Callable现在有一个 maxdepth 关键字参数，用于控制生成的树的深度。

  • 这个 toctree 模板中的Callable现在接受 titles_only 关键字参数。

  • 补充 htmltitle 布局模板中的块。

  • 在javascript搜索中，允许搜索包含模块名的对象名，如 sys.argv .

  • 新增主题 haiku 受俳句操作系统用户指南的启发。

  • 新增主题 nature .

  • 新增主题 agogo 由Andi Albrecht创建。

  • 新增主题 scrolls 由Armin Ronacher创建。

  • #193: 添加了一个 visitedlinkcolor “主题”选项设置为默认主题。

  • #322: 通过异步加载搜索索引提高了搜索页面的响应性。

• 扩展API：

  • 补充 html-collect-pages .

  • 增列 needs_sphinx 配置值和 require_sphinx() 应用程序API方法。

  • #200: 增列 add_stylesheet() 应用程序API方法。

• 扩展：

  • 增加了 viewcode 延伸。

  • 增加了 extlinks 延伸。

  • 添加了对AutoDoc中成员的源排序的支持， autodoc_member_order = 'bysource' .

  • 增列 autodoc_default_flags 配置值，可用于为所有AutoDoc指令选择默认标志。

  • 添加了Interspinx在其他项目中引用命名标签的方法，并指定要链接到的项目。

  • #280: AUTODOG现在可以记录在 __init__ 方法：研究方法。

  • 许多改进和修复 autosummary 多亏了保利·维塔南。

  • #309: 这个 graphviz 扩展现在可以输出SVG而不是PNG图像，由 graphviz_output_format 配置值。

  • 补充 alt 选择权 graphviz 扩展指令。

  • 补充 exclude 参数 autodoc.between() .

• 翻译：

  • 加上克罗地亚语翻译，多亏了Bojan Mihela_。

  • 加上土耳其语的翻译，多亏了菲拉特·奥古尔。

  • 加泰罗尼亚语翻译，多亏了保罗·费尔恩·恩德斯。

  • 增加了简体中文翻译。

  • 感谢Hjorth Larsen，增加了丹麦语翻译。

  • 加上立陶宛语的翻译，多亏了多布拉沃斯基。

• 修复错误：

  • #445: 属性生成的HTML的搜索功能时，修复指向结果页的链接 dirhtml 建筑商。

  • #444: 在模板中，正确地重新转义使用“striptag”JJJA过滤器处理的值。

版本0.6.7(2010年6月5日)

• #440: 删除中使用的Python>=2.5 API literalinclude 指令。

• 修复了阻止在LaTeX构建器中生成某些引用的错误。

• #428: 为标准Docutils类添加一些缺少的CSS样式。

• #432: 修复在翻译的区域中构建LaTeX时出现的UnicodeError错误。

版本0.6.6(2010年5月25日)

• 中处理原始节点。 text 作家。

• 修复Qt帮助项目生成的问题 qthelp 生成器，将导致在Qt助手中不显示任何内容。

• #393: 时，修复数学公式中Unicode字符的用法 pngmath 分机。

• #404: 制作 \and 在的作者字段中正常工作 latex_documents 布景。

• #409: 使之成为 highlight_language 配置值在LaTeX生成器中工作正常。

• #418: 允许将转换脚本文件重新定位到Unix系统上的系统目录。

• #414: 修复文件中Windows换行的处理 literalinclude 指令。

• #377: 修复了Linkcheck生成器中的崩溃。

• #387: 修复中搜索结果的显示 dirhtml 输出。

• #376: 在AutoDoc中，修复了包含反斜杠的参数默认值的显示。

• #370: 修复了LaTeX输出中复杂列表项标签的处理。

• #374: 使之成为 doctest_path Doctest扩展的配置值实际有效。

• 修复在为创建全局目录时对多个目录树的处理 toctree() 模板函数。

• 对象创建全局目录时对隐藏目录树的处理 toctree() 模板函数。

• 修复文本编写器中嵌套列表的处理。

• #362: 在AutoDoc中，检查是否存在 __self__ 在访问函数对象之前。

• #353: 在搜索功能中提取搜索词时，去掉前导和尾随空格。

版本0.6.5(2010年3月01日)

• 在AutoDoc中，修复使用文档注释显式记录的某些模块成员的遗漏。

• #345: 使用修复侧栏滚动条的裁剪 stickysidebar 默认主题的选项。

• #341: 始终在快速入门生成文件中生成Unix换行符。

• #338: 修复与一起运行 -C 在Windows下。

• 在自动对接中，允许在内置机制失败的情况下自定义对象的签名。

• #331: 修复LaTeX中具有起始值的枚举列表的输出。

• 使之成为 start-after 和 end-before 选项添加到 literalinclude 指令如果不一起使用，则可以正常工作。

• #321: 修复LaTeX构建器中的链接生成。

版本0.6.4(2010年1月12日)

• 改进配置中对非Unicode字符串的处理。

• #316: 捕获在使用不理解的参数调用graph viz时发生的OSErrrors。

• 恢复与Pygments>=1.2的兼容性。

• #295: 修复了LaTeX输出中超参照目标的转义。

• #302: 修复由 :doc: Latex 产量的作用。

• #286: 在读取整个文档后收集待办事项节点；这允许在待办事项中放置替换引用。

• #294: 不要忽略显式 today LaTeX版本中的配置值。

• 这个 alt 继承关系图的文本现在干净多了。

• 生成链接标题时忽略部分标题中的图像。

• #310: 支持中的异常消息 testoutput 数据块中的 doctest 分机。

• #293: 在HTML输出中，行块的样式设置正确。

• #285: 使之成为 locale_dirs 配置值再次起作用。

• #303: html_context 通过命令行给出的值 -A 不应覆盖conf.py中给出的其他值。

• 修复阻止增量重建的错误 dirhtml 建筑商。

• #299: 修复某些文字块中引号的损坏。

• #292: 的搜索索引的固定路径 dirhtml 建筑商。

• 修复Jython兼容性问题：使依赖于 parser 模块可选。

• #238: 在AutoDoc中，捕获模块导入时发生的所有错误，而不仅仅是 ImportError 。

• 修复了AutoDoc中对非数据但非方法描述符的处理。

• 复制文件时间时，忽略由引发的操作系统错误 os.utime() 。

版本0.6.3(2009年9月03日)

• 正确添加C模块文件名作为AutoDoc中的依赖项。

• #253: 忽略不带内容的graph viz指令，而不是引发未经处理的异常。

• #241: 修复了包含todolist指令的文档的构建LaTeX输出崩溃。

• #252: 使快速入门生成的生成文件中的构建目录更容易更改。

• #220: 修正css，使displayath真正居中。

• #222: 允许翻译“脚注”页眉。

• #225: 不要在生成的HTML中将空格添加到行内标签之后。

• #227: 制作 literalinclude 当文档的路径名包含非ASCII字符时使用。

• #229: 使用引发错误的成员修复AutoDoc故障 getattr() 。

• #205: 复制文件时，不要复制完整的统计信息，只复制修改时间。

• #232: 支持Qt帮助生成器中的非ASCII元数据。

• 正确格式化嵌套在LaTeX定义列表中的项目符号列表。

• 现在允许在内部使用章节标题 only 指令。

• #201: 制作 centered 指导 Latex 产品的生产。

• #206: 拒绝覆盖Shinx-QuickStart中的现有主文档。

• #208: 使用MS认可的区域设置，由 language 配置选项，在HTML帮助生成器中。

• #210: 修复了pngath扩展中显示的数学的HTML标记的嵌套问题。

• #213: 修正了LaTeX输出中图像居中的问题。

• #211: 修复了与Docutils 0.5的兼容性。

版本0.6.2(2009年6月16日)

• #130: 修复doctest扩展中的模糊索引错误。

• #167: 使词汇表排序与大小写无关。

• #196: 如果扩展模块没有 setup() 功能。

• #158: 允许使用‘..’在模板名称和绝对模板路径中；默认情况下，JJUJA 2禁用这两个选项。

• 高亮显示Python代码时，在尝试将其解析为Python之前，请忽略额外的缩进。

• #191: 不要逃脱LaTeX中URI中的波浪号。

• 不考虑搜索索引的源评论的内容。

• 将默认编码设置为 utf-8-sig 要正确处理具有UTF-8 BOM的文件。

• #178: 应用 add_function_parentheses C的配置值如承诺的那样起作用。

• #173: 尊重文献者 title 指令。

• #172: 这个 obj 角色现在如承诺的那样链接到模块。

• #19: 表现在可以有一个“长表”类，以便在LaTeX输出中正确地分成几页。

• 在尝试之前，在系统默认路径中查找Sphinx消息目录 sphinx/locale 。

• 修复通过“类名.方法名”搜索方法的问题。

• #155: 修复了与Python2.4的兼容性：旧式类是例外。

• #150: 修复了Internet Explorer版本6和7上的“sphinxdoc”主题的显示。

• #146: 当用户有活动时，不要失败生成LaTeX .docutils 配置。

• #29: Don't generate visible "-{-}" in option lists in LaTeX.

• 在替换时修复交叉引用角色。

• 不要将图像“alt”文本放入目录条目中。

• 在LaTeX编写器中，不要在太多的区段级别上引发异常，只需对所有区段级别使用“分段”级别。

• #145: 修复自动成员拒绝从其父级获取attr()‘d的自动对接问题。

• 如果在命令行上给出了要构建的特定文件名，请检查它们是否在源目录中。

• 修复对象在不使用 __name__ 。

• 修复没有urllib2.HTTPSHandler的安装的intersphinx。

• #134: 修复使用TODO扩展中的todolist指令时的Pending_xref剩余节点。

版本0.6.1(2009年3月26日)

• #135: 修复LaTeX输出和graph viz扩展的问题。

• #132: 在发行版中包含自动摘要“模块”模板。

版本0.6(2009年3月24日)

添加了新功能

• 不兼容的更改：

  • 模板化现在需要JJIA2库，它是旧的JJIA1引擎的增强版本。由于语法和语义在很大程度上是相同的，所以自定义模板中应该只需要很少的修复。

  • “Document”div标记已移出 layout.html 模板的“文档”块，因为结束标记已经在外部。如果覆盖此块，还需要删除“Document”div标记。

  • 这个 autodoc_skip_member 事件现在还可以决定是否跳过名称以下划线开头的成员。以前，这些成员总是被自动跳过。因此，如果处理此事件，请向事件处理程序添加类似以下内容的内容以恢复旧行为：：

    if name.startswith('_'):
        return True
    

• 主题支持，请参阅文档中的新部分。

• Markup：

  • 由于大众的需求，增加了一个 :doc: 角色，该角色直接链接到另一个文档，而不需要创建标签 :ref: 可以链接到。

  • #4: 添加了一个 :download: 标记要包含在HTML输出中的非文档文件和指向该文件的链接的角色。

  • 添加了一个 only 指令，该指令可以基于启用的“标记”选择性地包括文本。可以在命令行上给出标记。此外，当前构建器输出格式(例如“html”或“laTeX”)始终是已定义的标记。

  • #10: 添加了HTML节编号，可通过给出 :numbered: 将标志添加到 toctree 指令。

  • #114: 添加了一个 abbr 用于标记缩写和首字母缩写的角色。

  • 这个 literalinclude 指令现在支持多个选项，以仅包括文件的一部分。

  • 这个 toctree 指令现在支持 :hidden: 标志，它将防止在指令的位置生成链接--这允许您定义文档结构，但您可以自己放置链接。

  • #123: 这个 glossary 指令现在支持 :sorted: 按字母顺序对术语表条目进行排序的标志。

  • 图像、文字包含文件和下载文件的路径现在可以是绝对路径(如 /images/foo.png )。它们被视为相对于顶层源目录。

  • #52: 现在有一个 hlist 指令，通过将分发项放入多个列来创建紧凑列表。

  • #77: 如果具有信息的描述环境字段列表仅包含一个 :param: 条目，则不会生成项目符号列表。

  • #6: 不生成冗余 <ul> 对于顶级目录树项目，这导致目录项的可视分隔。

  • #23: 添加了一个 classmethod 指令以及 method 和 staticmethod 。

  • 缩放的图像现在可以链接到未缩放的版本。

  • 现在，在HTML(通过)中支持SVG图像 <object> 和 <embed> 标签)。

  • 添加了一个 toctree 可调用模板，以及在目录树中包含外部链接的能力。‘折叠’关键字参数指示是否仅显示当前页面的子项。(默认为 True 。)

• 配置：

  • 新的配置值 rst_epilog 可以包含附加到每个读取的源文件的REST。这是全球替代的正确地点。

  • 新的 html_add_permalinks 配置值可用于关闭为每个标题和定义环境生成的“段落符号”固定链接。

  • 新的 html_show_sourcelink 配置值可以用来关闭侧边栏中指向REST源代码的链接。

  • 的缺省值 htmlhelp_basename 现在是项目标题，清理为文件名。

  • 新的 modindex_common_prefix 配置值可用于忽略模块索引排序的某些程序包名。

  • 新的 trim_footnote_reference_space 配置值反映同名的Docutils配置值，并删除脚注引用之前的空格，这是REST识别引用所必需的。

  • 新的 latex_additional_files 配置值可用于复制文件(Sphinx不会自动复制文件，例如，如果它们被添加到 latex_elements )添加到构建目录。

• 建筑商：

  • HTML构建器现在存储一个名为的小文件 .buildinfo 在其输出目录中。它存储配置值的散列，该散列可用于确定是否需要完成完全重建(例如，在更改之后 html_theme )。

  • 新的建设者为Qt帮助收集，安东尼奥华伦天奴。

  • 新的 DirectoryHTMLBuilder (简称 dirhtml )为每个页面创建一个单独的目录，并将页面放在一个名为 index.html 。因此，页面URL和链接不需要包含 .html 。

  • 新的 html_link_suffix 配置值可用于选择在HTML文件之间生成的链接的后缀。

  • #96: 现在，LaTeX生成器在使用 figwidth 选项和右/左对齐。

• 新译本：

  • 意大利人，桑德罗·丹特拉著。

  • 乌克兰人，彼得罗·萨斯尼克。

  • 芬兰语：Jukka Inkeri。

  • 作者：Alexander Smishlajev。

• 扩展和API：

  • 新的 graphviz 对嵌入式图形图形的扩展。

  • 新的 inheritance_diagram 要嵌入的扩展...继承图！

  • 新的 autosummary 生成模块摘要和模块自动文档的扩展。

  • AutoDoc现在有了一个可重用的PythonAPI，它可以用来创建自定义类型的对象来自动文档(例如Zope接口)。另请参阅 Sphinx.add_autodocumenter() 。

  • AUTODOC现在可以处理记录的属性。

  • AutoDoc现在处理内部类及其方法。

  • AutoDoc现在可以将类记录为函数，如果显式标记为 autofunction 。

  • Autodoc键现在可以从文档中排除单个成员。 exclude-members 选择。

  • AutoDoc现在可以按字母顺序(像以前一样)或按成员类型对成员进行排序；可以使用配置值进行配置 autodoc_member_order 或者是 member-order 根据指令选择。

  • 该功能 Sphinx.add_directive() 现在还支持Docutils 0.5样式的指令类。如果它们继承自 sphinx.util.compat.Directive ，它们还与Docutils 0.4一起工作。

  • 现在有一个 Sphinx.add_lexer() 方法，以便能够轻松使用自定义的Pygments词法分析器。

  • 现在有了 Sphinx.add_generic_role() 以反映Docutils自身的功能。

• 其他变化：

  • 现在可以在命令行上给出单个DICT键的配置覆盖。

  • 现在有一个 doctest_global_setup 可用于为文档中的所有文档测试提供设置代码的配置值。

  • HTML中的源链接现在是用 rel="nofollow" 。

  • QuickStart现在可以生成窗口 make.bat 文件。

  • #62: 现在有一个 -w 除了stderr之外，sphinx的选项还包括将警告写入文件的构建。

  • 现在有一个 -W 用于将警告转换为错误的Shinx-Build选项。

版本0.5.2(2009年3月24日)

• 适当地逃脱 | 在 Latex 产量中。

• #71: 如果源文件出现解码错误，请打印警告，并将字符替换为？

• 如果索引加载时间太长，则修复HTML搜索中的问题。

• 在解析时不要输出系统消息，因为即使KEEP_WARNINGS为FALSE，它们也会保留在文档树中。

• #82: 确定Docutils记录的依赖项的正确路径。这修复了具有从属文件的源始终报告为已更改的行为。

• 识别不在TOPLELEL节但在块项目(如表)中的toctree指令。

• 使用新的RFC基本URL，因为rfc.org似乎已关闭。

• 修复了未定义TODO项时todolist指令中的崩溃。

• 如果一次都没有找到，就不要反复调用LaTeX或dvipng，在这种情况下，请使用纯文本的LaTeX作为替代。

• 修复LaTeX输出中的脚注问题。

• 防止双连字符在LaTeX输出的文字代码中变为连字符。

• 以通用换行符模式打开文本包含文件，以允许任意换行符约定。

• 实际上就是让 -Q 选项行得通。

• #86: 修复目录树中的显式文档标题。

• #81: 以安全的方式编写环境和搜索索引，避免在转储过程中发生异常。

• #80: 修复使用setLocale()设置区域设置时的UnicodeErrors。

0.5.1版(2008年12月15日)

• #67: 即使在安静模式下运行，也会在doctest扩展中输出有关文档测试失败的警告。

• #72: 在pngath中，可以给出Windows上的LaTeX和dvipng的完整路径。为了让这一点奏效， pngmath_latex 和 pngmath_dvipng 选项不再分为命令和其他参数；使用 pngmath_latex_args 和 pngmath_dvipng_args 给出更多的论点。

• 不要在带有非ASCII字符的文档测试失败时崩溃。

• 在编写包含不可编码字符的状态消息和警告时，不要崩溃。

• 如果doctest扩展块不包含任何代码，则发出警告。

• 修复对 :param: 和 :type: 包含标记(尤其是交叉引用角色)的单据字段。

• #65: 修复由pngath扩展生成的PNG的深度信息存储。

• 修复了在类上下文之外使用automethod时自动对接崩溃的问题。

• #68: 修复具有指定高度的图像的LaTeX编写器输出。

• #60: 修复了在子目录中包含源中的图像时生成的错误图像路径。

• 修复了禁用html_Copy_SOURCE时的JavaScript搜索。

• 修复使用选项记录类时自动文档中的缩进问题 autoclass_content = "both" 准备好了。

• 不要在空的索引项上崩溃，只发出警告。

• 修复了搜索代码中的一个拼写错误，导致在某些设置中无法使用搜索功能。

版本0.5(2008年11月23日)--生日发布！

添加了新功能

• 标记功能：

  • 引用现在是全局的：任何文件中定义的所有引用都可以从任何文件中引用。引文被收集在 Latex 输出的参考书目中。

  • 现在可以在LaTeX生成器中正确处理脚注：它们出现在文本中脚注引用的位置，而不是在节的末尾。感谢安德鲁·麦克纳马拉的最初补丁。

  • “系统消息”警告现在自动从构建的文档中删除，并且只写入stderr。如果您需要旧的行为，请设置新的配置值 keep_warnings 至 True 。

  • 词汇表条目现在自动添加到索引中。

  • 带有标题的插图现在可以像章节标题一样引用，使用 :ref: 角色，但没有显式链接文本。

  • 增列 cmember 角色以保持一致性。

  • 按字母或罗马数字枚举的列表现在的处理方式与标准REST中的类似。

  • 这个 seealso 指令现在还可以以缩写形式提供参数。

  • 您现在可以使用新的文档记录几个程序及其选项 program 指令。

• HTML输出和模板：

  • 不兼容的更改：“根”关系链接(relbar中的左上角)现在指向 master_doc 默认情况下，不再到名为“INDEX”的文档。旧的行为虽然在某些情况下很有用，但有些出乎意料。覆盖模板中的“rootrellink”块以自定义其引用的位置。

  • 现在，在全文中搜索之前，JavaScript搜索会先搜索对象。

  • TOC树条目现在具有允许根据其深度设置样式的CSS类。

  • 突出显示的代码块现在具有使其能够根据其语言设置样式的CSS类。

  • HTML <meta> 通过Docutils添加标签 meta 指令现在都受支持。

  • SerializingHTMLBuilder 被添加为新的抽象构建器，可以子类化该抽象构建器以特定格式序列化生成的HTML。这个 PickleHTMLBuilder 是它的一个具体子类，它使用Pickle作为序列化实现。

  • JSONHTMLBuilder 被添加为另一个 SerializingHTMLBuilder 将生成的HTML转储到JSON文件以供进一步处理的子类。

  • 这个 rellinks 布局模板中的块现在被称为 linktags 以避免与relbar链接混淆。

  • HTML构建器现在有两个额外的属性，可用于在标题和定义链接之后禁用锚链接创建。

  • 仅当文档中有一些模块时才生成模块索引。

• 新的和更改的配置值：

  • 在生成的文本中添加了对国际化的支持 language 和 locale_dirs 配置值。非常感谢语言贡献者：

    • 霍斯特·古特曼--德国人

    • 帕维尔·科西纳--捷克语

    • 大卫·拉莱特--法国人

    • MichałKandulski--波兰语

    • Yasushi Masuda--日语

    • Guillem Borrell--西班牙语

    • 吕克·萨弗尔和彼得·贝特尔斯--荷兰人

    • 林瑞德--繁体中文

    • 罗杰·德米特雷斯库--巴西葡萄牙语

    • 韩国加尔巴斯--斯洛文尼亚人

  • 新的配置值 highlight_language 设置高亮显示的全局默认设置。什么时候 'python3' 时，控制台输出块被识别为类似于 'python' 。

  • 皮吉特斯的词法分析器猜测被曝光为一种亮点 guess 。

  • 新的配置值 latex_elements 允许覆盖默认情况下Sphinx放入生成的.tex文件中的所有 Latex 片段。

  • 增列 exclude_dirnames 可用于从源文件搜索中排除CVS目录的配置值。

  • 增列 source_encoding 用于选择输入编码的配置值。

• 扩展：

  • 新的扩展模块 sphinx.ext.jsmath 和 sphinx.ext.pngmath 为HTML和LaTeX构建器提供数学支持。

  • 新的扩展 sphinx.ext.intersphinx 半自动创建指向其他项目中的Python对象的Sphinx文档的链接。

  • 新的扩展 sphinx.ext.todo 允许插入“to do”指令，其在输出中的可见性可以切换。它还添加了一个指令来编译所有待办事项的列表。

  • Sphinx.ext.AutoDoc有一个新事件 autodoc-process-signature 这允许调优函数签名自检。

  • Sphinx.ext.AutoDoc有一个新事件 autodoc-skip-member 这允许调整生成的内容中包含哪些成员。

  • 敬重 __all__ 自动记录模块成员时。

  • 这个 automodule 指令现在支持 synopsis ， deprecated 和 platform 选择。

• 扩展API：

  • Sphinx.add_node() 现在接受可选的访问程序方法，用于HTML、LaTeX和文本翻译器；这避免了必须手动修补类。

  • 增列 Sphinx.add_javascript() 这将添加要在默认的HTML模板中加载的脚本。

  • 添加了新活动： source-read ， env-updated ， env-purge-doc ， missing-reference ， build-finished 。

• 其他变化：

  • 添加了一个命令行开关 -Q ：它将抑制警告。

  • 添加了一个命令行开关 -A ：它可用于向HTML模板提供附加值。

  • 添加了一个命令行开关 -C ：如果给定，则没有配置文件 conf.py 是必需的。

  • 添加了distutils命令 build_sphinx ：安装Sphinx后，您可以调用 python setup.py build_sphinx 对于包含Sphinx文档的项目，Sphinx文档将构建文档并将其放置在标准的distutils构建目录中。

  • 在快速入门中，如果选定的根路径已经包含Sphinx项目，请投诉并中止。

修复错误

• #51: 转义放置在HTML模板中的配置值。

• #44: 修复HTML帮助索引生成中的小问题。

• 修复表格中线块的LaTeX输出。

• #38: 修复了使用像素图像宽度/高度时的“非法单位”错误。

• 支持LaTeX输出中的表格标题。

• #39: 解决JJJA中的一个错误，该错误导致在HTML输出中发出“<生成器...>”。

• 修复了LaTeX输出中未生成模块链接的问题。

• 修复了对不同目录中图像的处理。

• #29: 文本写入器中的支持选项列表。确保引入长选项名称的破折号没有缩写为连字符。

• 支持对HTML输出中的图像进行“缩放”选项。

• #25: 正确转义HTML帮助属性值中的引号。

• 修复某些描述性环境的LaTeX版本 :noindex: 。

• #24: 不要在不常见的角色名称大小写时崩溃(如 :Class: )。

• 仅在彩色端子上输出ANSI颜色。

• 更新到最新的fncychap.stein，以修复章节标题开头的非ASCII字符的问题。

• 修复了在LaTeX输出中生成索引的问题，该问题是由于最后没有包括Hyperref而引起的。

• 不要忽略没有任何参数的函数的返回注释。

• 不要丢弃代码块的标签。

版本0.4.3(2008年10月8日)

• 修复了自动对接中直接给出的自动对接成员的错误。

• 修正了在AutoDOC中导入一个模块两次的错误，一次是作为“模块”，一次是作为“模块”。

• 修复了在创建副本的HTML编写器中的错误 id Docutils 0.5的章节标题的属性。

• 适当地调用 super() 在模板中被替代的块中。

• 在使用XeTeX时添加修复程序。

• 统一胶乳逸出处理。

• 重建一切时， extensions 配置值更改。

• 不要试图删除不存在的静态目录。

• 修复生产列表中的缩进问题。

• 修复文字包含文件的编码处理： literalinclude 现在有一个 encoding 默认为UTF-8的选项。

• 修复了在快速入门中输入的非ASCII字符的处理。

• 修复不存在的图像URI的崩溃。

版本0.4.2(2008年7月29日)

• 修复了对 samp 在HTML中的角色。

• 修复带有指向错误页面的标题的LaTeX链接的错误。

• 添加或删除源文件时，重新阅读带有全局目录树的文档。

• 向PickleHTMLBuilder.HandlePage()添加缺少的参数。

• 始终将继承信息放在自己的行上。

• 不要自动用引号将带有空格的代码括起来；只对 samp 角色。

• 现在，当无法导入模块或找不到属性时，AutoDoc会发出更精确的错误消息。

• 现在，当引用找到的项目时，JavaScript搜索使用正确的文件名后缀。

• 自动模块指令现在接受 inherited-members 和 show-inheritance 又是选项。

• 现在，您可以在重新定位源目录和/或doctree目录后正常重建文档。

版本0.4.1(2008年7月5日)

• 向TextBuilder添加了下标/上标节点处理。

• 引用中的标签名称现在不区分大小写，因为REST标签名称总是小写的。

• 修复格式错误的URL的链接检查生成器崩溃。

• 添加了对警告和文档的兼容性0.5。

• 取消在Laex Writer中对“roubric”的愚蠢限制：您现在可以编写任意的“rubric”指令，只有标题为“脚注”的指令将被忽略。

• 将HTML徽标复制到输出 _static 目录。

• 修复名称和平台中带有下划线的模块的LaTeX代码。

• 修复非本地镜像URI的崩溃。

• 允许使用：noindex：in automodule 指令，如文件所示。

• 解决这个问题 delete() AutoDoc中的文档字符串处理器功能。

• 修复不存在的图像的警告消息。

• 修复Internet Explorer中的JavaScript搜索。

0.4版(2008年6月23日)

添加了新功能

• tocdepth 可以作为文件范围的元数据条目提供，并指定此文件的目录的最大深度。

• 新的配置值 default_role 可用于选择所有文档的默认角色。

• Sphinx现在使用如下字段解释字段列表 :param foo: 以描述单位表示。

• 新的 staticmethod 指令可用于将方法标记为静态方法。

• HTML输出：

  • “上一个”和“下一个”链接具有更合理的结构，因此，通过跟随“下一个”链接，您可以遍历整个目录树。

  • 新活动 html-page-context 可用于将自定义值包括到呈现HTML模板时使用的上下文中。

  • 文档元数据现在位于默认模板上下文中，名称为 metadata 。

  • 新的配置值 html_favicon 可用于设置HTML输出的收藏夹图标。多亏了塞巴斯蒂安·维斯纳。

  • 新的配置值 html_use_index 可用于关闭HTML文档中的索引生成。

  • 新的配置值 html_split_index 可用于为每个字母创建单独的索引页，以便在整个索引对于一页太大时使用。

  • 新的配置值 html_short_title 可用于为文档设置较短的标题，然后在导航栏中使用。

  • 新的配置值 html_show_sphinx 可用于控制是否将指向Sphinx的链接添加到HTML页脚。

  • 新的配置值 html_file_suffix 可用于将HTML文件后缀设置为例如 .xhtml 。

  • 中的目录 html_static_path 现在可以包含子目录。

  • 如果子模块的数量大于顶层模块的数量，模块索引现在不会折叠。

• IMAGE指令现在支持将扩展名指定为 .* ，这使得构建器选择最匹配的一个。多亏了塞巴斯蒂安·维斯纳。

• 新的配置值 exclude_trees 可用于从搜索源文件中排除整个子树。

• 配置值的缺省值现在可以是可调用的，这允许动态缺省。

• 新的TextBuilder创建纯文本输出。

• Python3样式签名，通过以下方式提供返回注释 -> ，现在都支持。

• 扩展：

  • AutoDoc扩展现在提供了一种更加灵活的方法，可以在将文档字符串包含到输出中之前对其进行操作，方法是通过新的 autodoc-process-docstring 事件。

  • 这个 autodoc 扩展现在接受函数、方法和类的签名，这些签名覆盖了通过自省从Python代码获得的签名。

  • 这个 autodoc 扩展现在提供了一个 show-inheritance 用于自动分类的选项，该选项在签名后插入碱基列表。

  • AUTODOC指令现在支持 noindex 标志选项。

修复错误

• 正确报告AutoDOC中包含的文档字符串的源位置。

• 修复具有多个签名的描述单元的LaTeX输出。

• 处理LaTeX输出中的Figure指令。

• 处理LaTeX输出中的原始警告。

• 修复了在HTML帮助输出中确定标题的问题。

• 处理包含空格的项目名称。

• 不要在HTML输出中编写类似SSI的注释。

• 为了与REST边栏保持不同，将“侧边栏”类重命名为“sphinxside bar”。

• 在HTML帮助生成中使用二进制目录来修复没有显式锚点的链接问题。

• 修复具有显式标题的函数/方法引用的行为。

• 支持LaTeX Writer中的引文、下标和上标节点。

• 将标准的“CLASS”指令作为“cssclass”提供；否则它将被Sphinx定义的指令跟踪。

• 修复了对指定给自动类指令的显式模块名称的处理。它们现在在生成的文档中显示正确的模块名称。

• 启用AutoDoc以处理Unicode文档字符串。

• LaTeX编写器现在使用以下命令转换行块 \raggedright ，它在桌子上玩得更好。

• 修复了HTML构建器静态路径中的目录错误。

版本0.3(2008年5月6日)

添加了新功能

• 这个 toctree 指令现在支持 glob 选项，该选项允许在内容中使用全局样式的条目。

• 如果 pygments_style 配置值包含一个圆点，它被视为自定义Pygments样式类的导入路径。

• 新的配置值， exclude_dirs 可用于从搜索源文件中排除整个目录。

• 配置目录(包含 conf.py )现在可以独立于源目录进行设置。为此，提供了一个新的命令行选项 -c 已添加。

• 新指令 tabularcolumns 可用于给出LaTeX输出的表格列规范。表现在使用 tabulary 包裹。文字块现在可以放在表中，但有几个警告。

• 新的配置值， latex_use_parts ，可用于启用LaTeX文档中的部件。

• AutoDoc现在跳过类的继承成员，除非您将新的 inherited-members 选择。

• 新的配置值， autoclass_content ，选择是否将类的文档字符串 __init__ 方法被添加到指令体中。

• 支持C++类名(在样式中 Class::Function )中的C函数描述。

• 支持 toctree_only 项中的项用于 latex_documents 配置值。这只包括输出中的TOC树引用的文档，而不包括包含指令的文件的其余部分。

修复错误

• Sphinx.htmlWriter：正确地为主文档的任何结构编写TOC文件。还可以将非ASCII字符编码为目录和索引文件中的实体。删除其余两个硬编码的“文档”实例。

• 现在可以正确检测描述符了。

• 实施所有的REST警告，而不仅仅是 note 和 warning 。

• 对 Latex 的产量和风格进行了大量的小调整。

• 修复OpenSearch模板，并将模板URL设置为绝对。这个 html_use_opensearch 配置值现在必须给出基本URL。

• 一些未使用的文件现在从HTML帮助文件构建中剥离。

版本0.2(2008年4月27日)

不兼容的更改

• 默认的HTML模板使用的模板引擎JJJA现在不再随Sphinx一起提供。如果它不是自动为您安装的(它现在作为依赖项列在 setup.py )，请从PyPI手动安装。如果您在SVN结账时使用Sphinx，那么也需要这个；在这种情况下，请同时删除 sphinx/jinja 可能是旧版本遗留下来的目录。

• 笨拙地处理 index.html 模板已删除。配置值 html_index 已经走了，而且 html_additional_pages 应该改为使用。如果你需要它，旧的 index.html 模板仍然在那里，名为 defindex.html ，您可以通过更改您的模板来移植您的html_index模板，使用JJJA继承：：

  {% extends "defindex.html" %}
  {% block tables %}
  ... old html_index template content ...
  {% endblock %}
  

  和推杆 'index': name of your template 在……里面 html_additional_pages 。

• 在布局模板中，冗余 block S被撤职；你应该使用金佳的标准 {{ super() }} 机制，正如(新编写的)模板文档中所解释的那样。

添加了新功能

• 扩展接口(应用程序对象)：

  • 支持一种新方法， add_crossref_type 。它的工作原理是 add_description_unit 但该指令只会创建一个目标，而不会输出。

  • 支持一种新方法， add_transform 。它需要一个标准的Docutils Transform 子类，然后由Sphinx的阅读器应用于解析REST文档树。

  • 通过添加一个称为“模板桥”的抽象，添加对除JJJA之外的其他模板引擎的支持。此类处理模板的呈现，并且可以使用新的配置值“TEMPLATE_BRIDER”进行更改。

  • 配置文件本身可以是扩展名(如果它提供了 setup() 功能)。

• Markup：

  • 新指令， currentmodule 。它可用于指示以下文档的模块名称，而无需创建索引项。

  • 允许为目录树中的文档指定不同的标题。

  • 允许在中提供多个选项 cmdoption 指令。

  • 修复了未给出显式类名的类成员的显示。

• 模板(HTML输出)：

  • index.html 已重命名为 defindex.html ，请参见上文。

  • 有一个新的配置值， html_title ，它控制Sphinx文档集的整体“标题”。现在到处都在使用它，而不是“Projectname vX.Y文档”。

  • 模板中对“Documentation”的所有引用都已删除，因此现在可以更轻松地将Sphinx用于具有默认模板的非文档文档。

  • 模板现在具有XHTMLdoctype，以与Docutils的HTML输出保持一致。

  • 现在，您可以使用 html_use_opensearch 配置值。

  • 现在，您可以在侧边栏中快速添加徽标 html_logo 配置值。

  • 侧边栏中有新的块，因此您可以轻松地将内容插入到侧边栏中。

• Latex 产量：

  • 这个 sphinx.sty 包裹被清理掉了不用的东西。

  • 您可以在标题页中使用 latex_logo 配置值。

  • 您可以为逐字记录环境定义链接颜色以及边框和背景颜色。

感谢雅各布·卡普兰-莫斯、塔林、杰伦·鲁格罗克·范德韦文和塞巴斯蒂安·维斯纳的建议。

修复错误

• Shinx.ext.AutoDoc：不检查 __module__ 用于显式指定的成员。删除类构造函数参数列表中的“self”。

• Sphinx.htmlWriter：不要使用os.Path来连接图像HREF。

• Sphinx.htmlWriter：不要将Smartyants用于HTML属性值。

• Sphinx.latexWriter：实现选项列表。此外，还进行了一些其他更改，以 sphinx.sty 以增强兼容性和去除旧的未使用的东西。这要感谢盖尔·瓦罗库！

• 修复引用带有显式目标的术语表术语的问题。

• 环境：在解析子树时不要吞下TOC条目。

• 快速启动：创建一个合理的默认LaTeX_DOCUMENTS设置。

• 环境：优雅地处理一些用户错误案例。

• Util：搜索文档时使用符号链接。

版本0.1.61950(2008年3月26日)

• 快速启动：修复Makefile的格式字符串。

版本0.1.61945(2008年3月26日)

• Sphinx.htmlWriter，sphinx.latexWriter：支持 .. image:: 指令，方法是将图像文件复制到输出目录。

• Builder：始终使用前导下划线来命名“特殊的”HTML输出目录；这意味着 _sources 和 _static 。

• 环境：在收集一组过时的源代码时，将依赖文件考虑在内。

• Sphinx.指令：随附的记录文件 .. literalinclude:: 作为从属关系。

• Sphinx.ext.AutoDoc：记录包含文档字符串作为依赖项的文件。

• Sphinx.Builder：在模板更改的情况下重新生成所有的HTML文件。

• Builder：在HTML构建器中更优雅地处理不可用的TOC关系(上一章/下一章)。

• LatexWriter：包含fncychap.tie，这在TeX发行版中似乎并不常见。添加 clean LaTeX Makefile中的目标。真正将正确的纸张和尺寸选项传递给LaTeX Document类。

• 设置：在Python2.4上，如果已经安装了Docutils，就不要依赖于Docutils--否则它将被覆盖。

版本0.1.61843(2008年3月24日)

• QuickStart：如果用户不想要Makefile，那就不要创建它。

• 设置：不要通过setupTools入口点和distutils脚本安装脚本两次。只能通过入口点安装。

• Sphinx.Builder：无法识别HTML构建器复制的源文件(在 _sources )作为输入文件，如果源后缀是 .txt 。

• 高亮显示：为LaTeX逐字生成正确的标记，即使没有安装Pygments，环境也会转义。

• Builder：WebHTMLBuilder现在称为PickleHTMLBuilder。

• HtmlWriter：使解析后的文本块按预期工作，而不是通过Pygments突出显示它们。

• 环境：在读取空的源文件时不要出错。

版本0.1.61798(2008年3月23日)

• Sphinx：使用Docutils SVN快照以及0.4。

• Sphinx.ext.doctest：使放置doctest块的组可选，默认为 'default' 。

• Sphinx.ext.doctest：替换 <BLANKLINE> 在doctest块中使用实际空行进行演示输出，并删除内联给出的doctest选项。

• 环境：从BLOCK_QUOTES中移出DOCSTEST_BLOCKS，以支持缩进的DOCUTEST块。

• Sphinx.ext.AutoDoc：渲染 .. automodule:: 节节点中的文档字符串，以便模块文档字符串可以包含正确的节。

• AutoDoc：使用模块的编码来解码文档字符串，而不需要ASCII。

版本0.1.61611(2008年3月21日)

• 第一次公开发布。