Sphinx 1.3

发布版本 1.3.6（发布于 2016年2月29日）

特性添加

  • #1873, #1876, #2278: 添加 page_source_suffix HTML 上下文变量. 这应该和 source_parsers 特性一起引入. 感谢 Eric Holscher.

修复的错误

  • #2265: 修复在 latex_elements 中禁用 babel 后仍然被使用的情况

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

  • #2291: 修复pdflatex “计数器太大”的错误,问题出在目录中的脚注

  • #2292:修复一些脚注在LaTeX输出中消失的问题

  • #2287:sphinx.transforms.Locale 始终使用 rst 解析器.Sphinx 的国际化功能应支持指定了 source_parsers 的解析器.

  • #2290: 修复 sphinx.ext.mathbase 使用 amsfonts 可能会破坏用户选择的数学字体

  • #2324: 当达到递归限制时,打印提示如何增加递归限制.

  • #1565, #2229: 恢复新的警告; 新的警告将在1.4版本开始触发.

  • #2329: 如源目录已改变,强制刷新环境.

  • #2019: 修复搜索结果中的域对象未转义的问题

版本 1.3.5（发布于 2016 年 1 月 24 日）

修复的错误

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

  • 修复未在引用警告中显示文件名

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

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

  • #2026: 修复 LaTeX 构建器在 parsed-literal 包含链接时引发的错误

  • #2243: 忽略类的奇怪文档字符串类型,避免崩溃

  • #2247: 修复 #2205 导致包含正则表达式字符串的分类器定义列表生成 HTML 失败

  • #1565: 如果 code-block 、 literalinclude 等的语法不正确,Sphinx 现在将发出跳过高亮的警告.

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

  • #2253::pyobject: 指令的 literalinclude 选项无法在块开始于空白或注释行时检测到缩进的主体块.

  • 修复当toctrees没有 :maxdepth: 时未显示TOC的问题（参考:#771）

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

Release 1.3.4（发布于 2016 年 1 月 12 日）

修复的错误

  • #2134:修复图像标题引用导致latex构建错误

  • #2094:修复在 Latex 中引用的 Rubric 无法正常工作

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

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

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

  • #967: 修复SVG继承图未超链接（不可点击）

  • #1237: 修复在LaTeX中的定义列表中脚注无法工作的问题

  • #2168: 修复原始指令在文本写入器中不起作用

  • #2171: 修复无法链接检查带有Unicode的URL

  • #2182: LaTeX: 支持文件名中有多个点的图像

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

  • #2003: 修复在运行 make linkcheck 时仅在 python2 下的解码错误

  • #2186: 修复数学中 mathbb 的 LaTeX 输出

  • #1480, #2188: LaTeX: 支持在章节标题中使用数学公式

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

  • #2040: 修复在sphinx-apidoc中,当作者包含非ASCII字符时出现的UnicodeDecodeError

  • #2193: 修复当源目录和目标目录相同时的 shutil.SameFileError

  • #2178:修复使用 :cpp:any: 引用函数时无法解析的 C++ 交叉引用

  • #2206: 修复由于脚注导致的Sphinx latex文档构建失败

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

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

  • #1815:修复 linkcheck 在 warniserror 设置为 true 且链接损坏时不引发异常的情况

  • #2197: 修复缺失index.rst文件时稍显晦涩的错误信息

  • #1894: 快速启动 Makefile 中未列出的虚假目标

  • #2125: 修复了合并字段（ GroupedField 和 TypedField ）的行为一致性

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

  • #771: 修复 latex 输出未设置 tocdepth

  • #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的目录（TOC）损坏问题

  • #2172: 修复sphinx.sty中功能失效的警告 \py@lightbox .感谢jfbu.

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

  • #2062:在Python 2中,文档测试中的转义字符处理不正确.

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

  • #2226: 修复当给定 :nowrap: 时数学未进行HTML编码 (jsmath, mathjax)

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

  • #2229: 修复未对未知选项给出警告

发布版本 1.3.3（发布于 2015 年 12 月 2 日）

修复的错误

  • #2177: 修复并行挂起

  • #2012: 修复当 numfig_format 无效时发生的异常

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

  • #2148: 构建devhelp目标时出现非ASCII文档错误.

Release 1.3.2（发布于2015年11月29日）

特性添加

  • #1935: 使 “numfig_format” 可在 latex_elements 中被重写.

修复的错误

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

  • 添加一个”default.css”样式表（导入”classic.css”）以便兼容性

  • #1788: graphviz扩展在存在caption选项时引发异常.

  • #1789::pyobject: 选项在 literalinclude 指令中包含类定义后的以下行

  • #1790:literalinclude 删除头部和尾部的空行

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

  • #1794: 从 alabaster 或 sphinx_rtd_theme 扩展的自定义主题找不到基础主题.

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

  • #1823: ‘.’ 作为 <module_path> 在 sphinx-apidoc 中会导致不友好的错误.现在 ‘.’ 会自动转换为绝对路径.

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

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

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

  • #1793, #1819: “另请参阅”在文本输出中缺少换行.感谢Takayuki Hirai.

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

  • #1871: 修复具有一列和多行的表格的LaTeX输出.

  • 处理 Python 3.5 中缺少 HTMLParserError 异常的问题.

  • #1949: 在覆盖构建器中使用 safe_getattr 以避免在具有自定义行为的描述符上中止操作.

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

  • #1796:在py3上,自动构建.m0文件导致UnicodeDecodeError.

  • #1923: 仅在 babel latex 元素非空时使用 babel 特性.

  • #1942: 修复websupport中的KeyError.

  • #1903: 修复术语表条目奇怪的ID生成.

  • make text will crush if a definition list item has more than 1 classifiers as: term : classifier1 : classifier2.

  • #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的标题作为tableofcontents的标题

  • #1987: 修复在LaTeX构建器中 :menuselection: 和 :guilabel: 中忽略字符&的情况

  • #1994:为翻译和Web支持功能提供更多支持非标准解析器（如recommonmark解析器）.现在在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: MecabBinder 的 HTML 搜索功能在 Python 3 中无法工作.感谢 Tomoko Uchida.

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

修复的错误

  • #1769: 允许为目标目录生成快速启动文件/目录,而不覆盖现有的文件/目录.感谢 WAKAYAMA shirou.

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

  • #1766:消息 “至少需要 Python 2.6 才能运行” 至少令人误解.

  • #1772: 文档字符串中的交叉引用,例如 :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日）

不兼容的变更

  • 角色 ref , term 和 menusel 现在不再生成 emphasis 节点.如果你想保持斜体样式,请调整你的样式表.

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

特性添加

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

  • 现在,:confval:source_suffix 配置值可以是多个后缀的列表.

  • 添加通过源后缀指定源解析器的能力,使用配置值 source_parsers .

  • #1675: 新增了一个构建器,AppleHelpBuilder,用于构建 Apple 帮助书.

修复的错误

  • 1.3b3的更改破坏了先前的gettext输出,其中包含重复的msgid,例如”foo bar”和”版本更改在1.3: foo bar”.

  • #1745:latex构建器在脚注本身有脚注标记时导致最大递归深度超出.

  • #1748:在Python 2.6中,sphinx/ext/ifconfig.py中的语法错误.

  • #1658, #1750: 如果选项未以 -、/ 或 + 开头,则不会创建链接（并且会给出警告）.感谢 Hirai Takayuki.

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

  • #1700: 为:rst:dir:toctree 添加 :caption: 选项.

  • #1742::name: 选项用于 toctree 、code-block 和 literalinclude 指令.

  • #1756: 从1.3b3引入的搜索中不正确的章节标题.

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

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

文档

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

发布版本 1.3b3（发布于 2015年2月24日）

不兼容的变更

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

  • The gettext_enables config value has been renamed to gettext_additional_targets.

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

特性添加

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

    • 添加 alabaster 主题.

    • 添加 sphinx_rtd_theme 主题.

    • 默认的 HTML 主题已更名为 “classic”.虽然 “default” 仍然可用,但它将发出通知,建议使用新的 “ alabaster “ 主题.

  • 添加了 highlight_options 配置值.

  • The language config value is now available in the HTML templates.

  • The env-updated event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten.

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

  • 添加 todo_include_todos 配置选项到快速启动配置文件,处理方式如文档中所述.

  • 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 ,则可以翻译多个节点.支持的节点有:

    • ‘文字块’

    • ‘doctest-block’

    • ‘原始’

    • image

  • #1227: 在 conf.py 中添加 html_scaled_image_link 配置选项,以控制缩放图片链接.

修复的错误

  • LaTeX writer 现在为跨越多行的单元生成正确的标记.

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

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

  • 在Windows上,如果通过 python sphinx-build.py 调用Sphinx,则在Win32平台上make模式无法工作.

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

  • #1690: 使用 glob 选项的 toctree 现在也可以包含单个文档的条目,且文档具有明确的标题.

  • #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 has been restored in its backwards-compatibility; slated for removal in Sphinx 1.4.

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

发布版本 1.3b2（发布于 2014年12月5日）

不兼容的变更

  • 更新捆绑的 ez_setup.py 以适应需要 Python 2.6 或更高版本的 setuptools-7.0.

特性添加

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

  • PR#314,#1150:现在配置值会检查它们的类型.如果配置的值和默认值的类型不同,并且没有共享一个共同的非平凡基类,则会引发警告.

修复的错误

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

  • 修复 autodoc_docstring_signature 在类文档字符串中的签名无法正常工作.

  • 重新构建在添加源文件时会意外崩溃.

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

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

  • make-mode 在 Win32 平台上不起作用,如果 Sphinx 是通过 wheel 包安装的.

发布 1.3b1（发布于 2014年10月10日）

不兼容的变更

  • 删除对 Python 2.5、3.1 和 3.2 的支持.

  • 删除了对Docutils版本0.9及以下的支持.

  • 移除了 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 中,以避免读取模板目录中的 autosummary rst 模板.

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

  • gettext 构建器:默认情况下,gettext 不会将 uuid 信息输出到生成的 pot 文件中.请将 gettext_uuid 设置为 True 以输出 uuid 信息.此外,如果安装了 python-levenshtein 这个第三方包,将会提高计算时间.

  • gettext 构建器:默认情况下禁用提取/应用 ‘index’ 节点.请将 ‘index’ 设置为 gettext_enables 以启用提取索引条目.

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

特性添加

  • 添加对 Python 3.4 的支持.

  • 添加对 Docutils 0.12 的支持

  • 添加了 sphinx.ext.napoleon 扩展,以支持NumPy和Google风格的文档字符串.

  • 新增对源文件的并行读取（解析）的支持,使用 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 功能:为图形、表格和代码块分配编号.此功能通过 numfig , numfig_secnum_depth 和 numfig_format 进行配置.同时提供了 numref 角色.感谢 Takeshi Komiya.

  • PR#202: 允许在 :param: 文档字段中使用以 “.” 和 “~” 开头的引用,用于 Python.

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

  • #925: 允许在命令行中提供列表类型的配置值,像 -D key=val1,val2 一样.

  • #668: 允许 code-block 和 literalinclude 指令的行编号从任意行号开始,新增 lineno-start 选项.

  • PR#172,PR#266: code-block 和 literalinclude 指令现在可以添加 caption 选项,该选项在输出的代码前显示文件名.感谢 Nasimul Haque,Takeshi Komiya.

  • Prompt for the document language in sphinx-quickstart.

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

  • PR#236,#1456: apidoc: 添加一个 -M 选项,将模块文档放在子模块文档之前.感谢 Wes Turner 和 Luc Saffre.

  • #1434: 提供未压缩的jquery.js和underscore.js文件,以明确压缩文件的来源.

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

  • PR#255: 在生成 latex 引用时,为节点上定义的 ids 同时插入 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_build 为 True （默认值）并且 *.po 文件比 *.mo 文件更新时,自动从 *.po 文件编译 *.mo 文件.

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

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

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

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

  • PR#291: code-block 的标题被识别为引用目标的标题.感谢小宫武志.

  • 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: 指定的返回类型现在会尽可能转换为链接.

修复的错误

  • #1438: 将jQuery版本从1.8.3更新至1.11.1.

  • #1568: 修复当一个 “居中” 指令包含引用时崩溃的问题.

  • 现在 sphinx.ext.autodoc 再次与 python-2.5 一起工作.

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

  • #1174: 修复在:rst:role:program 或 makevar 等角色中应用智能引号的问题.

  • PR#235: websupport 的注释数据库模式缺少 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: 向快速启动生成的 Makefile 和 make.bat 添加覆盖目标.感谢 Matthias Troffaes.

  • #1251: 当指定 toctree :numbered: 选项和 :tocdepth: 元数据时,深度超过 :tocdepth: 的子节数将被缩减.

  • PR#260: 在引用标签中对下划线进行编码以便于latex导出.感谢Lennart Fricke.

  • PR#264: 修复无法解析带有 :name: 选项的图形节点的 xref 问题.感谢 Takeshi Komiya.

  • PR#265:修复无法通过xref捕获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-block 和 literalinclude 添加了dedent选项.感谢Zafar Siddiqui.

  • PR#268: 修复在单一HTML模式下编号部分无法正常工作的问题.由于部分ID冲突,这仍然是一个临时修复.感谢Takeshi Komiya的帮助.

  • PR#273, #1536: 修复带编号的循环 toctree 中的 RuntimeError.感谢 Takeshi Komiya.

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

  • PR#276, #1381:rfc 和 pep 角色支持自定义链接文本.感谢 Takeshi Komiya.

  • PR#277,#1513:在 c:function 的参数列表中突出显示函数指针.感谢Komiya Takeshi.

  • PR#278:修复了如果 toctree 仅放置在指令下,节条目会显示两次的问题.感谢 Takeshi Komiya.

  • #1547:pgen2 词法分析器不识别 ... 字面量（用于 py3 的省略号）.

  • PR#294: 在LaTeX构建器中,包裹浮动环境在写literal_block时,以避免标题和正文的分离.感谢小宫武.

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

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

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