Sphinx 1.3

版本 1.3.6 (发布于 2016 年 2 月 29 日)

新增功能

  • #1873, #1876, #2278: 添加 page_source_suffix html 上下文变量。这应该与 source_parsers 功能一起引入。感谢 Eric Holscher。

修复的 Bug

  • #2265: 修复在 latex_elements 中禁用 babel 后仍使用它的问题。

  • #2295: 避免在 Python 3 中使用 autodoc 枚举成员时出现字典修改错误。

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

修复的 Bug

  • 修复 LaTeX 和 texinfo 构建器中警告未显示行号的问题。

  • 修复引文警告未显示文件名的问题。

  • 修复 LaTeX 和 texinfo 构建器中警告未显示行号的问题。

  • 修复索引警告未显示行号的问题。

  • #2026: 修复如果解析的文字包含链接,LaTeX 构建器会引发错误的问题。

  • #2243: 忽略类中奇怪的 docstring 类型,不崩溃。

  • #2247: 修复 #2205 破坏了包含正则表达式样式的字符串的定义列表的 make html。

  • #1565: 如果 code-blockliteralinclude 等的语法不正确,Sphinx 现在会发出一个警告,提示已跳过高亮显示。

  • #2211: 修复表格单元格中的段落在 Latex 输出中不起作用的问题。

  • #2253: literalinclude 指令的 :pyobject: 选项无法检测以空行或注释行开头的缩进主体块。

  • 修复当 toctrees 没有 :maxdepth: 时,TOC 未显示的问题(参考:#771)。

  • 修复 :numref: 的警告消息,如果目标在孤立文档中(参考:#2244)。

版本 1.3.4 (发布于 2016 年 1 月 12 日)

修复的 Bug

  • #2134: 修复带有引用的图表标题导致 latex 构建错误的问题。

  • #2094: 修复带有引用的标题在 Latex 中不起作用的问题。

  • #2147: 修复 latex 中的 literalinclude 代码在页面中不换行的问题。

  • #1833: 修复如果 latex_show_urls 不是 None,电子邮件地址会再次显示的问题。

  • #2176: sphinx.ext.graphviz: 使用 <object> 而不是 <img> 嵌入 svg。

  • #967: 修复 SVG 继承图未超链接(可点击)的问题。

  • #1237: 修复 LaTeX 中定义列表中脚注不起作用的问题。

  • #2168: 修复原始指令对文本写入器不起作用的问题。

  • #2171: 修复无法使用 unicode 进行链接检查的问题。

  • #2182: LaTeX: 支持包含多个点的图像文件名。

  • #2189: 修复子目录中第一个文件的前一个兄弟链接使用最后一个文件,而不是根 toctree 中预期的前一个文件。

  • #2003: 修复在 python2 下运行 make linkcheck 时(仅限)解码错误的问题。

  • #2186: 修复 math 中 mathbb 的 LaTeX 输出。

  • #1480, #2188: LaTeX: 支持章节标题中的数学公式。

  • #2071: 修复在两个以上章节标题中出现相同脚注 => LaTeX/PDF Bug。

  • #2040: 修复 sphinx-apidoc 中作者包含非 ASCII 字符时出现 UnicodeDecodeError 的问题。

  • #2193: 修复如果源目录和目标目录相同则出现 shutil.SameFileError 的问题。

  • #2178: 修复引用带有 :cpp:any: 的函数时无法解析的 C++ 交叉引用问题。

  • #2206: 修复 Sphinx latex 文档构建因脚注而失败的问题。

  • #2201: 修复行数超过 30 行的表格的错误表格标题。

  • #2213: 将经典主题中的 <blockquote> 设置为与 <p> 匹配。

  • #1815: 修复如果 warniserror 设置为 true 且链接损坏,linkcheck 不会引发异常的问题。

  • #2197: 修复缺少 index.rst 文件时略显神秘的错误消息。

  • #1894: quickstart Makefile 中未列出的虚假目标。

  • #2125: 修复折叠字段(GroupedFieldTypedField)统一行为的问题。

  • #1408: 复制前检查 latex_logo 的有效性。

  • #771: 修复 latex 输出未设置 tocdepth 的问题。

  • #1820: 在 Windows 上,使用 colorama 0.3.3 版本时控制台着色已损坏。现在 Sphinx 使用 colorama>=0.3.5 来避免这个问题。

  • #2072: 修复章节标题中的脚注未在 PDF 输出中显示的问题。

  • #1580: 修复 longtable 中的段落未在 Latex 输出中起作用的问题。

  • #1366: 修复居中图像在 latex 中未居中的问题。

  • #1860: 修复 man 页面使用带有花括号的 :samp: - 字体未重置的问题。

  • #1610: Sphinx 在某些系统中进行日语索引时崩溃。

  • 修复 mecab 初始化失败时 Sphinx 崩溃的问题。

  • #2160: 修复如果章节包含图像,PDF 的 TOC 损坏的问题。

  • #2172: 修复 sphinx.sty 中 dysfunctional admonition \py@lightbox 的问题。感谢 jfbu。

  • #2198,#2205: make gettext 为定义列表生成损坏的 msgid。

  • #2062: 在 Python 2 中,doctests 中的转义字符处理不正确。

  • #2225: 修复如果选项不以破折号开头,则不执行链接的问题。

  • #2226: 修复当给出 :nowrap: 时,数学未进行 HTML 编码的问题 (jsmath, mathjax)。

  • #1601, #2220: 'any' 角色破坏了扩展域行为。受影响的扩展不支持 resolve_any_xref 并且 resolve_xref 返回有问题的节点而不是 None。sphinxcontrib-httpdomain 是其中之一。

  • #2229: 修复对未知选项没有警告的问题。

版本 1.3.3 (发布于 2015 年 12 月 2 日)

修复的 Bug

  • #2177: 修复并行挂起的问题。

  • #2012: 修复如果 numfig_format 无效则发生异常的问题。

  • #2142: 在 PyPI 上为源分发在 sphinx/search/non-minified-js/*.js 中提供非压缩的 JS 代码。

  • #2148: 使用非 ASCII 文档构建 devhelp 目标时出错。

版本 1.3.2 (发布于 2015 年 11 月 29 日)

新增功能

  • #1935: 使 "numfig_format" 在 latex_elements 中可覆盖。

修复的 Bug

  • #1976: 避免使用 Babel 的 "2.0" 版本,因为它在 Windows 环境下无法工作。

  • 添加 "default.css" 样式表(它导入 "classic.css")以实现兼容性。

  • #1788: 当存在 caption 选项时,graphviz 扩展会引发异常。

  • #1789: literalinclude 指令的 :pyobject: 选项包含类定义之后的行。

  • #1790: literalinclude 剥离开头和结尾的空行。

  • #1802: 当 theme.conf 将其用作 'inherit' 时,自动加载插件主题。感谢 Takayuki Hirai。

  • #1794: 继承自 alabastersphinx_rtd_theme 的自定义主题找不到基本主题。

  • #1834: Docutils 0.13 兼容性:docutils.io.FileInput 的 handle_io_errors 关键字参数导致 TypeError。

  • #1823: sphinx-apidoc 的 <module_path> 使用 '.' 会导致不友好的错误。现在 '.' 会自动转换为绝对路径。

  • 修复设置不支持元数据的扩展时崩溃的问题。

  • #1784: 在 sphinx/search/non-minified-js/*.js 中提供非压缩的 JS 代码。

  • #1822, #1892: 修复 #1061 的回归。自从 Sphinx 1.3b3 以来,autosummary 无法为导入的成员生成文档。感谢 Eric Larson。

  • #1793, #1819: "see also" 在文本输出中缺少换行符。感谢 Takayuki Hirai。

  • #1780, #1866: "make text" 显示两次 "class" 关键字。感谢 Takayuki Hirai。

  • #1871: 修复 LaTeX 输出中只有一列和多行的表格。

  • 解决 Python 3.5 中缺少 HTMLParserError 异常的问题。

  • #1949: 在 coverage 构建器中使用 safe_getattr 以避免因具有自定义行为的描述符而中止。

  • #1915: 不要在文档字段类型注释中生成智能引号。

  • #1796: 在 py3 中,自动化的 .mo 构建导致 UnicodeDecodeError。

  • #1923: 仅当 babel latex 元素不为空时才使用 babel 功能。

  • #1942: 修复 websupport 中的 KeyError。

  • #1903: 修复词汇表术语的奇怪 ID 生成问题。

  • 如果定义列表项有多个分类器,例如:term : classifier1 : classifier2,则 make text 将崩溃。

  • #1855: make gettext 为带有分类器的定义列表生成损坏的 po 文件。

  • #1869: 修复处理包含非 ASCII 字符的文件时出现的问题。感谢 Marvin Schmidt。

  • #1798: 修复在标题中包含引用时构建 LaTeX 的问题。

  • #1725: 在 py2 环境中,使用非 ASCII 字符的 doctest 会导致 'ascii' codec can't decode byte 异常。

  • #1540: 修复循环引用 toctree 导致的 RuntimeError。

  • #1983: i18n 翻译功能破坏了使用章节名称的引用。

  • #1990: 在 LaTeX 中使用 toctree 的标题作为目录的标题。

  • #1987: 修复在 LaTeX 构建器中,:menuselection::guilabel: 中的 & 符号被忽略的问题。

  • #1994: 更多地支持非标准解析器(如 recommonmark 解析器)用于翻译和 WebSupport 功能。现在在 Docutils 转换期间,node.rawsource 回退到 node.astext()。

  • #1989: 在 Windows 上,"make blahblah" 每次都会显示 sphinx-build 的帮助信息。这是由 Sphinx 1.3.0/1.3.1 生成的错误 make.bat 引起的。

  • 在 Py2 环境中,sphinx-quickstart 生成的 conf.py 应该为 'version' 和 'release' 具有带有 u 前缀的配置值。

  • #2102: 在 Windows + Py3 环境下,使用 |today| 和非 ASCII 日期格式将引发 UnicodeEncodeError。

  • #1974: UnboundLocalError: 当同时使用 any 角色和 sphinx.ext.intersphinx 时,局部变量 'domain' 在赋值前被引用。

  • #2121: 当单词跨越页面标题和页面内容时,多词搜索找不到页面。

  • #1884, #1885: 插件 html 主题不能继承另一个插件主题。感谢 Suzumizaki。

  • #1818: sphinx.ext.todo 指令在 language 指定为非 ASCII 语言区域(如 'ru' 或 'ja')时,生成损坏的 html 类属性 'admonition-'。为了解决这个问题,现在 todo 指令可以使用 :class: 选项。

  • #2140: 修复表格中的脚注在 LaTeX 中损坏的问题。

  • #2127: 用于 html 搜索功能的 MecabBinder 在 Python 3 中不起作用。感谢 Tomoko Uchida。

版本 1.3.1 (发布于 2015 年 3 月 17 日)

修复的 Bug

  • #1769: 允许为不覆盖现有文件/目录的目标目录生成 quickstart 文件/目录。感谢 WAKAYAMA shirou。

  • #1773: sphinx-quickstart 不接受非 ASCII 字符作为选项参数。

  • #1766: “运行至少需要 Python 2.6” 的消息充其量是误导性的。

  • #1772: docstrings 中的交叉引用,如 :param .write: 破坏了构建。

  • #1770, #1774: literalinclude 使用空文件时发生异常。感谢 Takayuki Hirai。

  • #1777: Sphinx 1.3 无法加载额外的皮肤。感谢 tell-k。

  • #1776: source_suffix = ['.rst'] 在早期版本中导致不友好的错误。

  • #1771: 自动 .mo 构建无法正常工作。

  • #1783: Autodoc: Python2 允许 __all__ 中使用 unicode 字符串。感谢 Jens Hedegaard Nielsen。

  • #1781: 将 html_domain_indices 设置为列表会引发类型检查警告。

版本 1.3 (发布于 2015 年 3 月 10 日)

不兼容的变更

  • 角色 reftermmenusel 现在不再生成 强调 节点。如果希望保留斜体样式,请调整样式表。

  • 角色 numref 使用 %s 作为特殊字符来指示图号的位置,而不是 # 符号。

新增功能

  • 为 C++ 域添加便捷指令和角色:指令 cpp:var 作为 cpp:member 的别名,角色 :cpp:var 作为 :cpp:member 的别名,以及角色 any 用于交叉引用任何 C++ 声明。#1577, #1744。

  • source_suffix 配置值现在可以是一个包含多个后缀的列表。

  • 使用 source_parsers 配置值,添加了按源后缀指定源解析器的功能。

  • #1675: 添加了一个新的构建器 AppleHelpBuilder,用于构建 Apple 帮助手册。

已修复的错误

  • 1.3b3 的更改打破了之前包含重复 msgid 的 gettext 输出,例如 "foo bar" 和 "version changes in 1.3: foo bar"。

  • #1745: 当脚注本身包含脚注标记时,latex 构建器会导致最大递归深度超出。

  • #1748: Python 2.6 中 sphinx/ext/ifconfig.py 出现 SyntaxError。

  • #1658, #1750: 如果选项不以 -, / 或 + 开头,则不创建链接(并发出警告)。感谢 Takayuki Hirai。

  • #1753: C++,添加了对更复杂声明的缺失支持。

  • #1700: 为 toctree 添加 :caption: 选项。

  • #1742: 为 toctreecode-blockliteralinclude 指令提供了 :name: 选项。

  • #1756: 1.3b3 引入的搜索结果中章节标题不正确。

  • #1746: C++,修复了名称查找过程,并添加了声明中缺失的查找。

  • #1765: C++,修复旧 ID 生成以使用完全限定名。

文档

  • #1651: 为 python 域添加 vartype 字段描述。

版本 1.3b3 (发布于 2015 年 2 月 24 日)

不兼容的更改

  • 依赖要求更新:Docutils 0.11,Pygments 2.0

  • gettext_enables 配置值已重命名为 gettext_additional_targets

  • #1735: 使用 https://docs.pythonlang.cn/ 而不是 http 协议。它用于 sphinx.ext.intersphinx 和一些文档。

新增功能

  • #1346: 添加新的默认主题;

    • 添加 ' alabaster' 主题。

    • 添加 ' sphinx_rtd_theme' 主题。

    • “default” html 主题已重命名为 “classic”。“default” 仍然可用,但它会发出使用新 “alabaster” 主题的推荐通知。

  • 添加了 highlight_options 配置值。

  • language 配置值现在在 HTML 模板中可用。

  • env-updated 事件现在可以返回一个值,该值被解释为需要重写的附加文档名称的可迭代对象。

  • #772: 支持 C++ 中的有作用域和无作用域枚举。无作用域枚举中的枚举器除了注入到枚举作用域外,还注入到父作用域。

  • todo_include_todos 配置选项添加到 quickstart conf 文件,并按照文档中的描述进行处理。

  • HTML 面包屑项标签具有类 "nav-item" 和 "nav-item-N" (例如 nav-item-0, 1, 2…)。

  • 新的选项 sphinx-quickstart --use-make-mode 用于生成使用 sphinx-build make-mode 的 Makefile。

  • #1235: i18n: 如果在 conf.py 中将其设置为 gettext_additional_targets,则可以翻译多个节点。支持的节点是:

    • 'literal-block'

    • 'doctest-block'

    • 'raw'

    • 'image'

  • #1227: 添加 html_scaled_image_link 配置选项到 conf.py,用于控制缩放图像链接。

修复的错误

  • LaTeX 写入器现在生成跨越多行的单元格的正确标记。

  • #1674: 如果模块的 __all__ 不是字符串列表,则不会崩溃。

  • #1629: 在 LaTeX 中使用 VerbatimBorderColor 为代码块添加框架。

  • 在 Windows 上,如果 Sphinx 作为 python sphinx-build.py 调用,则 make-mode 在 Win32 平台上不起作用。

  • #1687: linkcheck 现在将 401 Unauthorized 响应视为“正常工作”。

  • #1690: 带有 glob 选项的 toctrees 现在也可以包含带有显式标题的单个文档条目。

  • #1591: C++ 元素的 html 搜索结果现在具有正确的页间链接。

  • bizstyle 主题:嵌套的长标题页面导致长面包屑,破坏了页面布局。

  • bizstyle 主题:在某些移动浏览器(iPhone5s safari)上,所有面包屑项都变为“顶部”。

  • #1722: 恢复在 1.3b1 中更改的 toctree() 模板函数行为。

  • #1732: i18n: 本地化表格标题引发异常。

  • #1718: :numref: 不适用于标签中的大写字母。

  • #1630: 解决 CSS 冲突,用于文字块包装器的 div.container css 目标现已重命名为 div.literal-block-wrapper

  • sphinx.util.pycompat 已恢复其向后兼容性;计划在 Sphinx 1.4 中移除。

  • #1719: LaTeX 写入器不尊重标题中的 numref_format 选项。

版本 1.3b2 (发布于 2014 年 12 月 5 日)

不兼容的更改

  • 更新了 bundled ez_setup.py,以适应 requiring Python 2.6 或更高版本的 setuptools-7.0。

新增功能

  • #1597: 添加了从 html-page-context 返回新模板名称的可能性。

  • PR#314, #1150: 现在检查配置值的类型。如果配置值和默认值类型不同且不共享共同的非平凡基类,则会发出警告。

Bug 修复

  • PR#311: sphinx-quickstart 在 python 3.4 上无法工作。

  • 修复 autodoc_docstring_signature 在类 docstrings 中包含签名时不起作用的问题。

  • 意外地因添加源文件而导致重建时崩溃。

  • #1607: 修复使用 "howto" 类构建 latexpdf 时崩溃的问题。

  • #1251: 再次修复。深度低于 :tocdepth: 的章节不应显示在 localtoc 侧边栏中。

  • 如果 Sphinx 是通过 wheel 包安装的,make-mode 在 Win32 平台上无法工作。

版本 1.3b1 (发布于 2014 年 10 月 10 日)

不兼容的更改

  • 放弃对 Python 2.5、3.1 和 3.2 的支持。

  • 放弃对 Docutils 0.9 版本及以下的支持。

  • 移除了 sphinx.ext.oldcmarkup 扩展。

  • 已移除已弃用的配置值 exclude_treesexclude_dirnamesunused_docs

  • 已添加一个新的节点 sphinx.addnodes.literal_strong,用于以粗体字体显示的字面文本(即没有智能引号)。自定义写入器需要进行调整以处理此节点。

  • PR#269, #1476: 将 <tt> 标签替换为 <code>。如果 css 包含 tt> 标签的样式,则用户自定义的样式表应进行更新。感谢 Takeshi Komiya。

  • #1543: templates_path 自动添加到 exclude_patterns,以避免读取模板目录中的 autosummary rst 模板。

  • 自定义域应实现新的 Domain.resolve_any_xref 方法,以使 any 角色正常工作。

  • gettext 构建器:gettext 默认不向生成的 pot 文件发出 uuid 信息。请将 True 设置为 gettext_uuid 以发出 uuid 信息。此外,如果安装了 python-levenshtein 第三方包,它将提高计算时间。

  • gettext 构建器:默认禁用提取/应用“index”节点。请将“index”设置为 gettext_enables 以启用提取索引条目。

  • PR#307: 在 LaTeX 中为代码块添加框架。感谢 Takeshi Komiya。

新增功能

  • 添加对 Python 3.4 的支持。

  • 添加对 Docutils 0.12 的支持。

  • 添加了 sphinx.ext.napoleon 扩展,用于支持 NumPy 和 Google 风格的 docstring。

  • 添加了使用 sphinx-build -j 选项并行读取(解析)源文件的支持。第三方扩展需要检查兼容性,如果它们将信息存储在构建环境对象中,可能需要进行调整。请参阅 env-merge-info

  • 添加了 any 角色,可用于查找 任何 类型 任何 域的交叉引用。自定义域应实现新的 Domain.resolve_any_xref 方法以使其正常工作。

  • 异常日志现在包含 Sphinx 发出的最后 10 条消息。

  • 添加了对扩展版本的支持(setup() 返回的字符串,这些字符串可以显示在回溯日志文件中)。扩展的版本要求可以使用新的 needs_extensions 配置值在项目中指定。

  • 现在支持使用 default-role 指令更改文档中的默认角色。

  • PR#214: 添加了对 14 种语言的词干提取支持,因此内置文档搜索现在可以处理这些语言。感谢 Shibukawa Yoshiki。

  • PR#296, PR#303, #76: numfig 功能:为图、表和代码块分配编号。此功能由 numfignumfig_secnum_depthnumfig_format 配置。同时 numref 角色也可用。感谢 Takeshi Komiya。

  • PR#202: 允许 Python 的 :param: doc 字段中使用 "." 和 "~" 前缀的引用。

  • PR#184: 添加了 autodoc_mock_imports,允许模拟在自动生成文档时不需要存在的外部模块的导入。

  • #925: 允许在命令行上提供列表类型的配置值,例如 -D key=val1,val2

  • #668: 允许 code-blockliteralinclude 指令的行号从任意行号开始,使用新的 lineno-start 选项。

  • PR#172, PR#266: code-blockliteralinclude 指令现在可以有一个 caption 选项,用于在输出中代码前显示文件名。感谢 Nasimul Haque, Takeshi Komiya。

  • 在 sphinx-quickstart 中提示文档语言。

  • PR#217: 添加了配置值以抑制生成的 gettext 目录中的 UUID 和位置信息。

  • PR#236, #1456: apidoc: 添加 -M 选项,将模块文档置于子模块文档之前。感谢 Wes Turner 和 Luc Saffre。

  • #1434: 为 jquery.js 和 underscore.js 提供非压缩的 JS 文件,以澄清压缩文件的来源。

  • PR#252, #1291: Windows 彩色控制台支持。感谢 meu31。

  • PR#255: 生成 latex 引用时,也为节点上定义的 id 插入 latex 目标/锚点。感谢 Olivier Heurtier。

  • PR#229: 允许注册其他翻译器。感谢 Russell Sim。

  • 添加 app.set_translator() API 以注册或覆盖 Docutils 翻译器类,例如 html_translator_class

  • PR#267, #1134: 为 literalinclude 添加 'diff' 参数。感谢 Richard Wall 和 WAKAYAMA shirou。

  • PR#272: 添加了 'bizstyle' 主题。感谢 Shoji KUMAGAI。

  • gettext_auto_buildTrue(默认值)且 *.po 文件比 *.mo 文件新时,自动编译 *.mo 文件。

  • #623: sphinx.ext.viewcode 支持导入的函数/类别名。

  • PR#275: sphinx.ext.intersphinx 支持多个目标的清单。感谢 Brigitta Sipocz。

  • PR#261: 添加了 env-before-read-docs 事件,可以连接到它来修改环境读取文档之前的文档顺序。

  • #1284: 使用 option 文档化的程序选项现在可以以 + 开头。

  • PR#291: code-block 的标题被识别为引用目标的标题。感谢 Takeshi Komiya。

  • PR#298: 添加新 API:add_latex_package()。感谢 Takeshi Komiya。

  • #1344: 添加 gettext_enables 以启用将“index”提取到 gettext 目录输出/将翻译目录应用于生成的文档。

  • PR#301, #1583: 允许 literalinclude 指令的行号与包含文件的行号匹配,使用新的 lineno-match 选项。感谢 Jeppe Pihl。

  • PR#299: 为 sphinx-quickstart 添加各种选项。静默模式选项 --quiet 将跳过向导模式。感谢 WAKAYAMA shirou。

  • #1623: 使用 :rtype: 指定的返回类型现在如果可能,将转换为链接。

Bug 修复

  • #1438: jQuery 版本从 1.8.3 更新到 1.11.1。

  • #1568: 修复“centered”指令包含引用时崩溃的问题。

  • 现在 sphinx.ext.autodoc 再次支持 python-2.5。

  • #1563: add_search_language() 对正确类型的参数引发 AssertionError。感谢 rikoman。

  • #1174: 修复智能引号在 programmakevar 等角色内部应用的问题。

  • PR#235: websupport 的评论数据库 schema 缺少 node_id 字段的长度。感谢 solos。

  • #1466,PR#241: 修复 cpp 域解析器解析 C+11 “变参模板” 声明失败的问题。感谢 Victor Zverovich。

  • #1459,PR#244: 修复默认 mathjax js 路径指向 http:// 导致 HTTPS 服务器上出现混合内容错误的问题。感谢 sbrandtb 和 robo9k。

  • PR#157: autodoc 移除 @property 修饰属性的虚假签名。感谢 David Ham。

  • PR#159: 将 coverage 目标添加到 quickstart 生成的 Makefile 和 make.bat。感谢 Matthias Troffaes。

  • #1251: 当指定 toctree :numbered: 选项和 :tocdepth: 元数据时,深度大于 :tocdepth: 的子节编号被缩小。

  • PR#260: 在 latex 导出中,对引用标签中的下划线进行编码。感谢 Lennart Fricke。

  • PR#264: 修复带有 :name: 选项的图形节点无法解析交叉引用的问题。感谢 Takeshi Komiya。

  • PR#265: 修复无法通过交叉引用捕获 graphviz 节点的标题的问题。感谢 Takeshi Komiya。

  • PR#263, #1013, #1103: C++ 域的重写。感谢 Jakob Lykke Andersen。

    • 到所有找到的嵌套名称和模板参数的超链接 (#1103)。

    • 支持函数类型,例如,在 std::function<bool(int, int)> 中 (#1013)。

    • 支持虚函数。

    • 更改了函数参数的解释,以遵循标准原型声明,即 void f(arg) 表示 arg 是参数的类型,而不是其名称。

    • 更新了测试。

    • 更新了文档,详细描述了支持的声明以及命名空间声明如何影响声明和交叉引用查找。

    • 索引名称现在可能不同。元素按其完全限定名称进行索引。更改此行为并可能按命名空间/类进行索引应该相当容易。

  • PR#258, #939: 为 code-blockliteralinclude 添加 dedent 选项。感谢 Zafar Siddiqui。

  • PR#268: 修复 singlehtml 模式下编号部分不起作用的问题。这仍然是临时修复,因为存在部分 ID 冲突的问题。感谢 Takeshi Komiya。

  • PR#273, #1536: 修复编号循环 toctree 导致的 RuntimeError。感谢 Takeshi Komiya。

  • PR#274: 如果 URL 出现在 toctree 中,将其 URL 设置为默认标题值。感谢 Takeshi Komiya。

  • PR#276, #1381: rfcpep 角色支持自定义链接文本。感谢 Takeshi Komiya。

  • PR#277, #1513: c:function 参数列表中函数指针的高亮显示。感谢 Takeshi Komiya。

  • PR#278: 修复如果 toctree 仅在指令下,则章节条目显示两次的问题。感谢 Takeshi Komiya。

  • #1547: pgen2 tokenizer 无法识别 ... 字面量 (Python 3 的省略号)。

  • PR#294: 在 LaTeX 构建器中,在写入 literal_block 时包裹浮动环境,以避免标题和正文分离。感谢 Takeshi Komiya。

  • PR#295, #1520: make.bat latexpdf 机制回到当前目录。感谢 Peter Suter。

  • PR#297, #1571: 为所有构建器添加 imgpath 属性。这使得开发构建器扩展更容易。感谢 Takeshi Komiya。

  • #1584: 在 HTML "top" 链接中指向主文档。

  • #1585: Sphinx 1.2.3 中模块的 Autosummary 损坏。

  • #1610: 当 MeCab 搜索选项启用但未安装 python-mecab 时,Sphinx 导致 AttributeError。

  • #1674: 如果模块的 __all__ 不是字符串列表,则不会崩溃。

  • #1673: 修复 nitpick_ignore:doc: 引用导致的崩溃。

  • #1686: ifconfig 指令不关心默认配置值。

  • #1642: 修复 Chrome 中只出现一个搜索结果的问题。

文档

  • 添加了关于标签语法的说明。(doc/markup/misc.rst