Sphinx 1.4

发布 1.4.9（于2016年11月23日发布）

修复的错误

  • #2936: 修复无法构建 man 页的 doc/Makefile,因为 doc/man 已存在

  • #3058: 在多个 ‘toctree’ 指令中使用相同的 ‘caption’ 属性会导致警告 / 错误

  • #3068: 允许在sphinx-build.py的-D选项中使用’=’字符

  • #3074:add_source_parser() 在调试模式下崩溃

  • #3135:sphinx.ext.autodoc 在普通 Callable 时崩溃

  • #3150: 修复JavaScript中的查询词分割器.它的行为与Python的正则表达式相同.

  • #3093: gettext 构建在替换图像上破裂.

  • #3093: 在 note 指令下,image 节点的 gettext 构建已损坏.

  • imgmath: 如果图像生成失败,则在显示错误消息时崩溃

  • #3117: 如果警告放置在第一个节标题之前,LaTeX 写入器崩溃

  • #3164: 更改 sphinx.ext.inheritance_diagram 的搜索顺序

释放 1.4.8（发布于 2016 年 10 月 1 日）

修复的错误

  • #2996: Sphinx的wheel包崩溃,出现ImportError

发布 1.4.7（于2016年10月1日发布）

修复的错误

  • #2890: 快速入门在所有错误条件下应始终返回错误

  • #2870:扁平化生成索引列的高度.

  • #2856:生成的HTML站点上的搜索无法找到某些符号

  • #2882: 在链接检查中,遇到403状态时回退到GET请求

  • #2902: jsdump.loads 无法加载以下划线开头的关键词的搜索索引

  • #2900: 修复 epub content.opf: 将自动生成的孤立文件添加到书脊.

  • #2899: 修复 Jinja2 模板中的 hasdoc() 函数.它将会检测 genindex 和 search .

  • #2901: 修复epub结果: 跳过从图片标签到原始图片文件的链接创建.

  • #2917: 行内代码在HTML中被断字

  • #1462: autosummary 对具有尾部下划线的 namedtuple 发出警告

  • 如果指定了 :nowrap: 选项,则无法引用公式

  • #2873: LaTeX中的代码块溢出（由于逗号）

  • #1060, #2056: sphinx.ext.intersphinx: 如果在 intersphinx_mapping 中使用相对路径,则会生成断开的链接

  • #2931: 使用相同 :caption: 的 code-block 指令会导致重复目标的警告.现在 code-block 和 literalinclude 不会自动使用其标题定义超链接目标.

  • #2962: latex: 缺少长表的标签

  • #2968: autodoc: show-inheritance 选项破坏文档字符串

发布 1.4.6（发布时间:2016年8月20日）

不兼容的更改

  • #2867:linkcheck生成器在six-1.4下崩溃.现在Sphinx依赖于six-1.5或更高版本

修复的错误

  • applehelp: 如果找不到 hiutil 或 codesign 命令,Sphinx 会崩溃

  • 修复当构建目录包含常规文件如 DS_Store 时 make clean 中止的问题.

  • 减少 epubcheck 警告/错误:

    • 修复 DOCTYPE 为 html5

    • 将扩展名从 .html 更改为 .xhtml.

    • 禁用电子书结果中的搜索页面

  • #2778: 修复当obj.__dict__是一个属性方法并引发异常时的autodoc崩溃

  • 修复epub3输出中重复的目录.

  • #2775: 修复不支持身份编码的服务器导致的链接检查失败

  • #2833:修复ext.autodoc中实例注释的格式问题.

  • #1911:-D 选项的 sphinx-build 不会覆盖 extensions 变量

  • #2789:sphinx.ext.intersphinx 在提供清单时生成错误的超链接

  • 在文档中显示代码块标题的解析错误（参考:#2845）

  • #2846:singlehtml 构建器不包括图形编号

  • #2816: 修复构建数据杂乱影响 Domain.initial_data 类属性

Release 1.4.5 (发布于 2016年7月13日)

不兼容的更改

  • latex,来自图像指令的非内联图像的包含导致根据原始图像宽度产生不一致的空白;在某些情况下,新行为必然与早期的行为不同.（参考:#2672）

  • latex,使用 \includegraphics 引用 Sphinx 自定义变体已被弃用;未来将恢复为原始 LaTeX 宏,自定义的已另有替代名称 \sphinxincludegraphics .

新增特性

  • 新的配置选项 latex_keep_old_macro_names ,默认值为 True .如果设置为 False ,则仅允许使用 \sphinx 前缀的名称定义宏（用于文本样式）

  • latex writer 允许用户通过三个长度变量自定义 “阴影 “框（主题）.

  • 现在epub生成器支持woff格式的web字体文件.

修复的错误

  • jsdump 修复用于 Python 3:修复了在 Python > 3 上的 HTML 搜索

  • #2676: (latex) 自 Sphinx 1.4.4 以来,标题中的逐字文本错误

  • #2629: memoir 类崩溃 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: 时生成空的 bullet_list

  • #2479:sphinx.ext.viewcode 默认使用 python2 高亮器

  • #2700: HtmlHelp生成器硬编码了index.html

  • latex,自1.4.4版以来,行内文字后面出现多余的空格

  • #2722: C++,修复变量/成员声明的ID生成以包括命名空间.

  • latex,列表或引用块中的图像（来自图像指令）未遵循缩进（已与 #2671 一起修复）

  • #2733: 自 Sphinx 1.4.4 起, make latexpdf 生成大量 hyperref 警告

  • #2731:sphinx.ext.autodoc 无法访问引发异常的属性方法

  • #2666: C++,正确查找涉及构造函数的嵌套名称.

  • #2579: 无法通过 sphinx.ext.intersphinx 引用同时包含空格和冒号的标签

  • #2718: 如果文档文件不能读取,Sphinx崩溃

  • #2699: 如果设置了 html_file_suffix ,帮助HTML中的超链接会被破坏

  • #2723:多行单元中的 LaTeX PDF 输出中的多余空格

  • #2735: latexpdf Underfull \hbox (badness 10000) 标题页警告

  • #2667: 如果在节标题中出现缩放的图像,则latex崩溃

  • #2763: (html) 为SVG源的图像标签提供必需的 alt 属性的默认值,以便进行验证,并与其他格式保持一致.

Release 1.4.4 （发布于2016年6月12日）

修复的错误

  • #2630: latex: sphinx.sty 通知环境格式问题

  • #2632: 在quote环境下,警告指令在latex构建中失败

  • #2633: Sphinx在旧格式索引时崩溃

  • 修复在 1.4.2 版本中 sphinx.sty 的 \begin{\minipage} 错误（参考:68becb1）

  • #2622: LaTeX 在标题和目录后产生空白页

  • #2640: 1.4.2 LaTeX 在警告指令内若有代码块则崩溃

  • 让LaTeX在内联代码中也使用直引号 (参见 #2627)

  • #2351: 如果带编号的列表放在脚注中,latex崩溃

  • #2646: 如果数学公式中包含连续两个空行,latex 会崩溃

  • #2480:sphinx.ext.autodoc : 显示了内存地址

  • latex: 允许代码块出现在列表和引用中的最大嵌套深度（参考 #777, #2624, #2651）

  • #2635: LaTeX 代码指令根据查看分辨率产生不一致的框架

  • #2639: Sphinx现在捆绑了iftex.sty

  • 构建带有framed.sty 0.95的PDF失败

  • Sphinx现在捆绑了needspace.sty

发布 1.4.3 (发布于 2016 年 6 月 5 日)

修复的错误

  • #2530: 当在警告中存在大型编号脚注时,构建PDF时出现 “计数器过大” 错误

  • 如果同时指定了 align 选项,则 width 选项在 figure 指令中无效（参考: #2595）

  • #2590:inputenc 宏包在 lualatex 和 xelatex 下导致编译失败

  • #2540:LaTeX首页日期使用不同字体

  • 如果文档被包含,则抑制 “文档未包含在任何 toctree 中” 的警告（参考: #2603）

  • #2614: 如果用户在前言中设置非零 parindent,某些PDF输出中的表格将会偏移

  • #2602: URL 重定向破坏了 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 写入器允许在主题内容中进行分页;并且它们的水平范围现在适合行宽（在边距中有阴影）.同时,警告类型的注意事项允许分页,并且它们的垂直间距已与提示类型通知的间距更一致（参考 #2446）.

  • #2459: LaTeX 输出中的字面代码块的框架（不仅仅是代码行本身）遵循列表或引用块中的缩进.

  • #2343:在LaTeX输出中,代码块中的长源代码行被换行（不修改行号）（参考#1534,#2304）.

修复的错误

  • #2370: 方程在LaTeX写入器中稍微错位

  • #1817, #2077: 抑制由sphinx-quickstart生成的conf.py中的pep8警告

  • #2407: 如果文档包含大型数据图像URI,则构建文档崩溃

  • #2436:如果加载扩展失败,Sphinx 不会通过 needs_sphinx 检查版本

  • #2397: 为土耳其文档设置简短的中断

  • #2447: VerbatimBorderColor 错误地用于 PDF 的标题

  • #2456: C++,修复与文档合并相关的崩溃（例如,单一HTML和Latex构建器）.

  • #2446: latex(pdf) 在不可断开的框中设置本地目录（或更一般的主题节点）,导致底部溢出

  • #2476: 如果给定 :nowrap: ,则省略 MathJax 标记

  • #2465: 如果没有为toctree指令提供caption选项,latex构建器将失败

  • 如果发现自我引用的toctree,Sphinx将崩溃

  • #2481: mecab搜索拆分器的拼写错误.感谢Naoki Sato.

  • #2309:修复无法通过 ref-role 引用 “间接超链接目标”

  • intersphinx 如果映射 URL 包含任何端口,将会失败

  • #2088: intersphinx 崩溃如果映射 URL 需要基本认证

  • #2304: LaTeX PDF 代码块中的自动换行

  • #1534: 在LaTeX的verbatim块中换行长行

  • #2460: PDF 输出中带标题的代码块顶部空白过多

  • 当加载多个数学扩展时显示错误原因（参考:#2499）

  • #2483: 如果图标题仅包含非文本对象,则未分配任何图号

  • #2501:LaTeX中的Unicode下标数字被规范化

  • #2492: 使用 :figwidth: 的图形指令生成错误的LaTeX代码

  • 图的标题总是居中显示,即使指定了 :align:

  • #2526: 如果部分只有图像,LaTeX 写入器崩溃

  • #2522: Sphinx在安装目录下修改mo文件,导致权限错误.

  • #2536: C++,修复当立即嵌套的作用域与当前作用域同名时发生的崩溃.

  • #2555: 修复Unicode导致的任何引用崩溃问题.

  • #2517: 使用LuaLaTeX时,PDF中的书签编码错误

  • #2521:如果找不到sphinx-build,生成的Makefile会导致BSD make崩溃

  • #2470:typing 反向移植包在 python 2.7 中导致 autodoc 错误

  • sphinx.ext.intersphinx crashes if non-string value is used for key of intersphinx_mapping

  • #2518:intersphinx_mapping 不允许非字母数字键

  • #2558: devhelp构建器上的解包错误

  • #2561: 当脚注包含链接时,Info构建器崩溃

  • #2565:由 sphinx.ext.autosummary 生成的对象描述在LaTeX写入器中出现行溢出

  • 在sphinx.sty中扩展pdflatex配置以支持子段落（参考:#2551）

  • #2445:rst_prolog 和 rst_epilog 影响非 reST 源

  • #2576:sphinx.ext.imgmath 在子进程引发错误时崩溃

  • #2577:sphinx.ext.imgmath : 传递给 dvisvgm 的参数无效

  • #2556: Xapian搜索在Python 3中无法工作

  • #2581: 如果语言为 “es”（西班牙语）,搜索将无法工作

  • #2382: 调整LaTeX编写器中图号缩写后的间距

  • #2383:latex_show_urls 生成的脚注溢出行

  • #2497, #2552: 搜索按钮的标签与按钮本身不匹配

发布版本 1.4.1（发布于 2016 年 4 月 12 日）

不兼容的更改

  • The default format of today_fmt and html_last_updated_fmt is back to strftime format again. Locale Date Markup Language is also supported for backward compatibility until Sphinx 1.5.

翻译

  • 新增了威尔士语翻译,感谢Geraint Palmer.

  • 增加了希腊语翻译,感谢 Stelios Vitalis.

  • 添加了埃斯佩兰托语翻译,感谢Dinu Gherman.

  • 添加了印地语翻译,感谢 Purnank H. Ghumalia.

  • 添加了罗马尼亚语翻译,感谢Razvan Stefanescu.

修复的错误

  • C++,增加对 extern 和 thread_local 的支持.

  • C++中,类型声明现在使用前缀 typedef 、 using 和 type ,具体取决于声明的风格.

  • #2413: C++,修复重复声明导致的崩溃

  • #2394: 当 html_last_updated_fmt 无效时,Sphinx 崩溃

  • #2408: Makefile 和 make.bat 中未提供虚拟构建器

  • #2412: 超链接目标在LaTeX构建器中损坏

  • 图形指令如果给定非段落项作为标题会崩溃

  • #2418: 今天格式中不再允许时间格式

  • #2395: 如果图像文件名中包含Unicode字符,Sphinx崩溃

  • #2396: “值过多,无法解包” 在 genindex-single 中

  • #2405:PDF中的numref链接跳转到错误的位置

  • #2414: PDF 超链接中缺失代码列表的编号

  • #2440: gmtime 的错误导入.感谢 Uwe L. Korn.

版本 1.4（发布于 2016 年 3 月 28 日）

不兼容的更改

  • 删除 PorterStemmer 包支持.使用 PyStemmer 替代 PorterStemmer 来加速词干提取.

  • sphinx_rtd_theme has become optional. Please install it manually. Refs #2087, #2086, #1845 and #2097. Thanks to Victor Zverovich.

  • #2231: 在LaTeX编写器中使用DUrole而不是DUspan进行自定义角色.这使得角色的标题可以作为自定义宏的参数.

  • #2022: ‘Thumbs.db’ 和 ‘.DS_Store’ 被添加到 exclude_patterns 的默认值中,这些将在 sphinx-quickstart 中提供的 conf.py 文件中.

  • #2027, #2208:html_title 仅接受字符串值.并且不接受 None 值.

  • sphinx.ext.graphviz: show graph image in inline by default

  • #2060, #2224:manpage 角色现在生成 sphinx.addnodes.manpage 节点,而不是 sphinx.addnodes.literal_emphasis 节点.

  • #2022: html_extra_path 现在也会复制额外目录中的点文件,并参考 exclude_patterns 来排除额外的文件和目录.

  • #2300 : 增强autoclass::以在__init__方法缺失或为空时使用__new__的文档字符串

  • #2251: 之前,在术语表指令下,一个定义的多个术语被转换为单个 term 节点,每个术语在术语节点中由 termsep 节点分隔.在新实现中,每个术语被转换为单独的 term 节点,并且 termsep 节点被移除.通过这个变化,每个构建器的输出布局略有变化.

  • 默认的高亮语言现在是 Python 3.这意味着源代码将被高亮显示为 Python 3（这基本上是 Python 2 的超集）,并且不会尝试解析以区分有效代码.要恢复旧的行为,请在 conf.py 中添加 highlight_language = "python" .

  • Locale Date Markup Language like "MMMM dd, YYYY" is default format for today_fmt and html_last_updated_fmt. However strftime format like "%B %d, %Y" is also supported for backward compatibility until Sphinx 1.5. Later format will be disabled from Sphinx 1.5.

  • #2327:latex_use_parts 现已被弃用.请改用 latex_toplevel_sectioning .

  • #2337: 在LaTeX写入器中使用 \url{URL} 宏替代 \href{URL}{URL} .

  • #1498: 手册页编写器:如果定义列表中包含强节点,不要将整个项加粗.

  • #582: 从HTML输出的快速搜索框中移除提示信息.

  • #2378: Sphinx 现在打包 newfloat.sty

新增特性

  • #2092: 在napoleon包中添加待办事项指令支持.

  • #1962: 当从扩展中添加指令、角色或节点时,如果该元素已存在（内置或由另一个扩展添加）,则发出警告.

  • #1909: 为 Intersphinx 库添加 “doc” 引用.

  • C++ 类型别名支持（例如, .. type:: T = int ）.

  • C++ 模板支持类、函数、类型别名和变量 (#1729, #1314).

  • C++,新增了作用域管理指令 namespace-push 和 namespace-pop .

  • #1970: 用于导航下一个和上一个主题的快捷键

  • Intersphinx: 添加对使用HTTP基本认证通过URL获取Intersphinx清单的支持.

  • C++,在函数信息字段列表中添加了对模板参数的支持.

  • C++,增加了对成员（函数）指针的支持.

  • #2113: 允许在代码块指令中使用 :class: 选项.

  • #2192: Imgmath（支持SVG的pngmath）.

  • #2200: 为LaTeX构建器支持XeTeX和LuaTeX.

  • #1906: 在可用的情况下,为LaTeX输出使用xcolor代替color来实现fcolorbox.

  • #2216: Texinputs makefile 改进.

  • #2170: 支持中文语言搜索索引.

  • #2214: 添加 sphinx.ext.githubpages 以在 GitHub Pages 上发布文档

  • #1030: 为latex_show_pagerefs制作可翻译的页面引用名称

  • #2162: 添加 Sphinx.add_source_parser() 以从扩展中添加 source_suffix 和 source_parsers

  • #2207: 添加 sphinx.parsers.Parser 类; 新解析器的基类

  • #656: 在graphviz指令中添加 graphviz_dot 选项来切换 dot 命令

  • #1939: 添加了 dummy 构建器:语法检查而不输出.

  • #2230: 添加 math_number_all 选项以对数学扩展中所有显示的数学公式进行编号

  • #2235:needs_sphinx 支持微版本比较

  • #2282: 在 “basic” 主题的 html 标签中添加 “language” 属性

  • #1779: 增加 EPUB 3 构建器

  • #1751: 添加 todo_link_only 以避免在 todolist 上显示文件路径和行号.感谢 Francesco Montesano.

  • #2199: 使用 imagesize 包来获取图像的大小.

  • #1099: 为linkcheck构建器添加可配置的重试次数.感谢Alex Gaynor.同时不检查以 ! 开头的锚点.

  • #2300 : 增强autoclass::以在__init__方法缺失或为空时使用__new__的文档字符串

  • #1858: 添加 Sphinx.add_enumerable_node() 以支持 numfig 特性中的可枚举节点

  • #1286, #2099: 添加 sphinx.ext.autosectionlabel 扩展以允许使用标题引用章节.感谢 Tadhg O’Higgins 的贡献.

  • #1854: 允许选择Janome作为日语分词器.

  • #1853: 支持在 HTML 搜索中使用 language='ja' 的自定义文本分割器.

  • #2320: 术语表术语的分类器可用于索引条目分组键.分类器也可用于翻译.另请参见 术语表 .

  • #2308: 定义 \tablecontinued 宏以重新定义长表的续表标签样式.

  • 如果多个图像被 .. image:: filename.* 匹配,请按相似性选择一个图像

  • #1921: 通过 language 和 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++,修复’signed char’和’unsigned char’作为类型的解析.

  • C++,添加对 ‘friend’ 函数的缺失支持.

  • C++,新增对虚基类的缺失支持（感谢 Rapptz）.

  • C++,添加对最终类的支持.

  • C++,修复带有’enum’前缀的类型解析.

  • #2023: 荷兰搜索支持使用丹麦词干信息.

  • C++,添加对用户自定义字面量的支持.

  • #1804: 现在html输出在侧边栏中包裹溢出的长文本.感谢Hassen ben tanfous.

  • #2183: 修复 porterstemmer 导致 make json 失败.

  • #1899: 确保列表被发送到 OptParse.

  • #2164: 修正sphinx.sty中对pdftex的错误检查（针对graphicx包选项）.

  • #2165, #2218: 从sphinx.sty中移除有缺陷和不必要的条件.

  • 修复如果给出未知语言则生成的损坏的LaTeX代码

  • #1944: 修复 rst_prolog 破坏文件范围的元数据

  • #2074: make gettext 应该使用规范的相对路径用于 .pot.感谢 anatoly techtonik.

  • #2311: 修复 sphinx.ext.inheritance_diagram 引发的 AttributeError

  • #2251:.rst 文件中的换行符错误地转移到 .pot 文件中.

  • #794: 修复latex输出中的日期格式化未本地化的问题

  • 从LaTeX写入器的supported_image_types中移除 image/gif (#2272)

  • 修复:如果LANGUAGE为空字符串,将引发ValueError

  • 修复在使用 Sphinx.add_crossref_type 生成的指令时出现的解包警告

  • 默认的高亮语言现在是 default .这意味着源代码将尽可能以 Python 3 的方式进行高亮（Python 3 大部分是 Python 2 的超集）.要恢复旧的行为,请在 conf.py 中添加 highlight_language = "python" .

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

  • #2331: 修复代码块在dvi中被块填充的问题;从xcolor包中移除 xcdraw 选项

  • 修复confval类型检查器,如果给定unicode而confval期望字符串值时会发出警告

  • #2360: 修复 LaTeX 输出中的 numref 错误

  • #2361: 修复 “compound” 指令内额外段落的缩进问题

  • #2364: 修复在从旧版本升级到 Sphinx 时出现的 KeyError ‘rootSymbol’.

  • #2348: 将amsmath和amssymb移到LaTeX写入器的fontpkg之前.

  • #2368: 默认忽略像 .#foo.rst 这样的 emacs 锁文件.

  • #2262: 在LaTeX输出中,literal_block及其标题被分页符分开.

  • #2319:修复表格计数器在LaTeX中被代码块覆盖的问题.感谢jfbu.

  • 修复与第三方域扩展结合时的解包警告.

  • #1153: 修复侧边栏中的图形导致的LaTeX构建错误.

  • #2358: 修复用户前言无法覆盖tocdepth定义.

  • #2358: 如果对于 top_sectionlevel 使用 part 或 chapter ,则减少 tocdepth

  • #2351: 修复脚注间距

  • #2363: 修复模板中的 toctree() 生成的链接在 SingleHTMLBuilder 中失效的问题.

  • #2366: 修复HTML生成器在toctree中生成空的hyperref.

文档