Sphinx1.4¶

版本1.4.9（2016年11月23日发布）¶

错误已修复¶

#2936：修复无法构建man的文档/Makeline，因为文档/man存在
#3058：在多个“toctree”指令中使用相同的“title”属性会导致警告/错误
#3068：允许在sphinx-build.py的-D选项中使用“=”字符
#3074： add_source_parser() 调试模式下崩溃
#3135： sphinx.ext.autodoc 与普通Callable崩溃
#3150：修复JavaScript中的查询单词拆分器。它的行为与Python的正规函数相同。
#3093：gettext build在替换的图像上损坏。
#3093：gettext构建在下的图像节点上损坏 note 指令。
imgmath：如果图像生成失败，则显示错误消息时崩溃
#3117：如果警告放在第一部分标题之前，LaTeX编剧就会崩溃
#3164：更改搜索顺序 sphinx.ext.inheritance_diagram

版本1.4.8（2016年10月1日发布）¶

错误已修复¶

#2996：Sphinx的轮子包因Import错误而崩溃

版本1.4.7（2016年10月1日发布）¶

错误已修复¶

#2890：Quickstart应在所有错误条件下一致返回错误
#2870：拉平genindex列的高度。
#2856：在生成的HTML网站上搜索未找到一些符号
#2882：回退到linkcheck中403状态的GET请求
#2902：如果关键字以强调线开头，jsdump.loads将无法加载搜索索引
#2900：修复epub内容。opf：将自动生成的孤立文件添加到spinal。
#2899：修复 hasdoc() 金杯2模板中的功能。它将检测 genindex , search also.
#2901：修复epub结果：跳过创建从图像标签到原始图像文件的链接。
#2917：内联代码在HTML上带有连字符
#1462：autosummary warns for namedtuple with attribute with trailing underscore
无法引用方程，如果 :nowrap: 选项指定
#2873：latex中的代码块溢出（由于逗号）
#1060，#2056：phinx.ext. interphinx：如果在中使用相对路径，则生成断开的链接 intersphinx_mapping
#2931：具有相同的代码块指令：标题：导致重复目标警告。现在 code-block 和 literalinclude 不会自动使用其标题定义超链接目标。
#2962：乳胶：长桌标签缺失
#2968：autodoc：show-inheritance选项打破了文档字符串

版本1.4.6（2016年8月20日发布）¶

不兼容的更改¶

#2867：linkcheck生成器崩溃，结果为6 -1.4。现在Sphinx取决于6 -1.5或更高版本

错误已修复¶

applehelp：Sphinx崩溃如果 hiutil 或 codesign 找不到命令
修复 make clean abort issue when build dir contains regular files like DS_Store .
减少epubcheck警告/错误：
- 将DOCTYPE修复到html5
- 将扩展名从.html更改为. xhtml。
- 禁用epub结果上的搜索页面
#2778：修复autodoc崩溃，如果 obj.__dict__ 是属性方法并引发异常
修复epub 3输出中重复的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日发布）¶

不兼容的更改¶

乳胶，从图像指令中包含非内联图像会导致不连贯的空白，具体取决于原始图像宽度;在某些情况下，新行为必然会与早期的行为不同。(ref：#2672）
乳胶，使用 \includegraphics 引用Sphinx自定义变体已被弃用;将来它将恢复为原始LaTeX宏，自定义宏已经有了替代名称 \sphinxincludegraphics .

功能添加¶

新配置选项 latex_keep_old_macro_names ，默认为 True .如果 False ，使宏（用于文本样式设置）只能用 \sphinx - 加后缀的名字
latex writer允许用户通过三个长度变量自定义“阴影”框（主题）。
epub构建器现在支持woff格式的Web字体文件。

错误已修复¶

jsdump修复Python 3：修复Python上的HTML搜索> 3
#2676：（乳胶）自Sphinx 1.4.4以来标题中出现逐字文本错误
#2629：回忆录课程崩溃LaTeX。固定 latex_keep_old_macro_names=False (ref 2675）
#2684： sphinx.ext.intersphinx 六人崩溃-1.4.1
#2679： float 所需的包裹 'figure_align': 'H' 乳胶选项
#2671：图像指令可能会导致pdf中的间隔不一致
#2705： toctree 如果出现以下情况，则生成空的子弹头列表 :titlesonly: 指定
#2479： sphinx.ext.viewcode 默认使用python2荧光笔
#2700：HtmlHelp builder has hard coded index.html
latex，因为1.4.4内联文本后面有虚假的空格
#2722：C++，修复var/member声明的id生成以包括名称空间。
latex，列表或引用块中的图像（来自image指令）不遵守缩进（与#2671一起修复）
#2733：自Sphinx1.4.4以来 make latexpdf 生成大量的hyperref警告
#2731： sphinx.ext.autodoc 不访问导致任何异常的属性方法
#2666：C++，正确查找涉及构造函数的嵌套名称。
#2579：无法通过引用包含空格和冒号的标签 sphinx.ext.intersphinx
#2718：如果文档文件不可读，Sphinx就会崩溃
#2699：如果出现以下情况，帮助HTML中的超链接将被破坏 html_file_suffix 设置
#2723：多行单元格的乳胶pdf输出中的额外空间
#2735：乳胶pdf Underfull \hbox (badness 10000) 标题页的警告
#2667：如果部分标题中出现调整大小的图像，乳胶就会崩溃
#2763：（html）为所需提供默认值 alt SVG源的图像标记的属性，需要验证，现在与其他格式一致。

版本1.4.4（2016年6月12日发布）¶

错误已修复¶

#2630：latex：sphinx.sty通知环境格式问题
#2632：警告指令在报价环境乳胶构建中失败
#2633：Sphinx与旧风格的索引崩溃
修复一个 \begin{\minipage} phinx.sty中的拼写错误，来自1.4.2（参考号：68becb1）
#2622：Latex在标题和目录后面生成空页面
#2640：1.4.2如果警告指令内部代码块，LaTeX就会崩溃
让LaTeX也在内联代码中使用直引号（参考#2627）
#2351：如果将列举列表放在脚注上，乳胶就会崩溃
#2646：如果数学包含两次白线，乳胶就会崩溃
#2480： sphinx.ext.autodoc ：显示内存地址
乳胶：允许代码块以最大嵌套深度出现在列表和引号内（参考#777、#2624、#2651）
#2635：乳胶代码指令根据观看分辨率产生不一致的帧
#2639：Sphinx现在捆绑iftex.sty
无法使用framed.sty 0.95构建PDF
Sphinx现在捆绑了needspac.sty

版本1.4.3（2016年6月5日发布）¶

错误已修复¶

#2530：如果警告中存在大编号脚注，则在构建PDF时出现“计数太大”错误
width figure指令的选项不起作用，如果 align 同时指定的选项（参考号：#2595）
#2590： inputenc 在lualatex和xelatex下编译的包中断
#2540：乳胶首页上的日期使用不同的字体
如果包含文档，则取消“文档未包含在任何toctree中”警告（参考号：#2603）
#2614：如果用户在序言中设置非零parallel，PDF输出中的某些表最终将发生移动
#2602：URL重定向会破坏由生成的超链接 sphinx.ext.intersphinx
#2613：如果加载合并的扩展，则显示警告
#2619：确保始终加载amstext LaTeX包（参考：d657225、488ee 52、9d82cad和#2615）
#2593：如果表中有任何数字，则乳胶崩溃

版本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输出中（参考#1534、#2304）。

错误已修复¶

#2370：LaTeX writer中的方程略有失调
#1817、#2077：抑制conf.py上由spinx-quickstart生成的pep 8警告
#2407：如果文档包括大数据图像uri，构建文档就会崩溃
#2436：Sphinx不检查版本 needs_sphinx 如果加载扩展失败
#2397：为土耳其文档设置缩写
#2447：VerbatimBorderColor错误地用于PDF标题
#2456：C++，修复与文档合并相关的崩溃（例如，singlehtml和Latex构建器）。
#2446：latex（pdf）在牢不可破的盒子中设置本地目录（或更一般的主题节点），导致底部溢出
#2476：如果给出：nowrap：，则忽略MathJax标记
#2465：如果未向toctree指令提供标题选项，乳胶生成器将失败
如果发现自引用的toctree，Sphinx就会崩溃
#2481：mecab搜索拆分器的拼写错误。感谢佐藤直树。
#2309：修复无法通过引用角色引用“间接超链接目标”
如果映射URL包含任何端口，则intersphinx失败
#2088：如果映射URL需要基本授权，interphinx就会崩溃
#2304：latexpdf代码块中的自动断线
#1534：用乳胶逐字块将长行进行文字包装
#2460：PDF输出中标题文字块顶部空白过多
加载多个数学扩展时显示错误原因（ref：#2499）
#2483：如果图标题仅包含非文本对象，则不分配任何图编号
#2501：Unicode下标数字在LaTeX中被规范化
#2492：Figure指令与：figwidth：生成不正确的Latex-code
即使数字的标题也总是放在中心 :align: 指定
#2526：LaTeX writer崩溃，如果只有图像的部分
#2522：Sphinx触摸已安装目录下的mo文件，导致权限错误。
#2536：C++，修复当直接嵌套的作用域与当前作用域同名时崩溃的问题。
#2555：使用Unicode修复任何引用的崩溃。
#2517：如果使用LuaLaTeX，PDF中的书签编码错误
#2521：如果找不到sphinx-Build，生成的Maketime会导致BDS make崩溃
#2470： typing backport包在python2.7中导致autodoc错误
sphinx.ext.intersphinx 如果非字符串值用于的键，则崩溃 intersphinx_mapping
#2518： intersphinx_mapping 不允许非字母数字键
#2558：DevHelp生成器上的解包错误
#2561：当脚注包含链接时，信息生成器崩溃
#2565：由生成的对象描述 sphinx.ext.autosummary LaTeX writer上的溢出行
将phinx.sty中的pdflatex配置扩展到小节（参考号：#2551）
#2445： rst_prolog 和 rst_epilog 对非reST来源的影响
#2576： sphinx.ext.imgmath 如果子进程出现错误，则崩溃
#2577： sphinx.ext.imgmath ：将无效参数传递给dvisvGM
#2556：Xapian搜索不适用于Python 3
#2581：如果langue =“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之前，还支持区域设置日期标记语言以向后兼容。

翻译¶

感谢Geraint Palmer，添加了威尔士语翻译。
增加了希腊语翻译，感谢Stelios Vitalis。
感谢Dinu Gherman，添加了世界语翻译。
添加了印地语翻译，感谢Purnank H。古马利亚。
感谢Razvan Stefanescu添加了罗马尼亚语翻译。

错误已修复¶

C++，添加了对 extern 和 thread_local .
C++，类型声明现在使用前置 typedef , using ，而且 type ，取决于声明的风格。
#2413：C++，修复重复声明的崩溃
#2394：当html_last_updated_fdt无效时，Sphinx崩溃
#2408：Makefile和make.mat中不可用虚拟构建器
#2412：LaTeX构建器中超链接目标被破坏
如果非段落项作为标题，数字指令就会崩溃
#2418：today_fdt不再允许时间格式
#2395：如果图像文件名中包含unicode字符，Sphinx将崩溃
#2396：genindex-single中“太多的值无法解压”
#2405：PDF中的numref链接跳到错误的位置
#2414：代码列表的PDF超链接中缺少数字
#2440：gmtime导入错误。感谢Uwe L.科恩。

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

不兼容的更改¶

下降 PorterStemmer 一揽子支持。使用 PyStemmer 而不是 PorterStemmer 以加速堵塞。
sphinx_rtd_theme 已成为可选的。请手动安装。参考#2087、#2086、#1845和#2097。感谢维克多·兹韦罗维奇。
#2231：对于LaTeX writer中的自定义角色，使用DUrole而不是DUspan。它允许将角色标题作为自定义宏的参数。
#2022：'Thumbs.db'和'.DS_Store'被添加到 exclude_patterns conf.py中的默认值，将在sphinx-quickstart上提供。
#2027、#2208： html_title 仅接受字符串值。和 None 价值不能被接受。
sphinx.ext.graphviz ：默认情况下以内联方式显示图形图像
#2060、#2224： manpage 角色现在生成 sphinx.addnodes.manpage 节点而不是 sphinx.addnodes.literal_emphasis node.
#2022： html_extra_path 还复制额外目录中的dotfile，并引用 exclude_patterns 以排除额外的文件和目录。
#2300：增强自动类：：使用的文档字符串 __new__ 如果 __init__ 方法缺少空
#2251：以前，根据术语表指令，一个定义的多个术语会转换为单个术语 term 节点，并且术语节点中的每个术语由 termsep node.在新的实现中，每个术语都转换为单个术语 term 节点和 termsep 节点被删除。通过这种变化，每个构建器的输出布局都有所改变。
默认的亮点语言现在是Python 3。这意味着源代码被突出显示为Python 3（主要是Python 2的超集），并且不会尝试进行解析来区分有效代码。要恢复旧行为，请添加 highlight_language = "python" to conf.py.
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现在捆绑newfloat.sty

功能添加¶

#2092：在Napoleon包中添加todo指令支持。
#1962：从扩展添加指令、角色或节点时，如果此类元素已经存在（内置或由另一个扩展添加），请发出警告。
#1909：将“Doc”引用添加到Interphinx库存。
C++类型别名支持（例如， .. type:: T = int ).
C++模板支持类、函数、类型别名和变量（#1729、#1314）。
C++，添加了新的范围管理指令 namespace-push 和 namespace-pop .
#1970：导航下一个和上一个主题的键盘快捷方式
Interphinx：添加了对使用HTTP基本身份验证的URL获取Interphinx清单的支持。
C++，在函数信息字段列表中添加了对模板参数的支持。
C++，增加了对成员（函数）指针的支持。
#2113：允许 :class: 代码块指令的选项。
#2192：Imgmath（pngmath，支持svg）。
#2200：支持LaTeX构建器的XeTeX和LuaTeX。
#1906：对于可用于LaTeX输出的fcolorbox，使用xcolorse而不是colorbox的颜色。
#2216：Texinuts makefile改进。
#2170：支持中文搜索索引。
#2214：添加sphinx.ext.githubpages以在GitHub Pages上发布文档
#1030：使latex_show_pageref的页面引用名称可翻译
#2162：添加Sphinx.add_source_parser（）以从扩展添加source_suffix和source_parser
#2207：添加phinx.parsers.Parser类;新解析器的Base Class
#656：添加 graphviz_dot 选项graphviz指令以切换 dot 命令
#1939：添加了 dummy 构建器：语法检查，不带输出。
#2230：添加 math_number_all 选项在数学扩展中对所有显示的数学进行编号
二二三五号： needs_sphinx 支持微版本比较
#2282：将“语言”属性添加到“基本”主题中的html标签
#1779：添加EPub 3构建器
#1751：添加 todo_link_only 为了避免文件路径和行指示 todolist .感谢Francesco Montesano。
#2199：使用 imagesize 包以获取图像的大小。
#1099：将可配置的再试次添加到链接检查生成器。感谢亚历克斯·盖纳。也不要从开始检查锚 ! .
#2300：增强自动类：：使用的文档字符串 __new__ 如果 __init__ 方法缺少空
#1858：添加Sphinx.add_accurable_note（）以添加numfig功能的可触发节点
#1286、#2099：添加 sphinx.ext.autosectionlabel 扩展允许使用其标题引用部分。感谢塔赫格·奥希金斯。
#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++，修复了将“有符号char”和“无符号char”解析为类型的问题。
C++，添加对“朋友”函数缺失的支持。
C++，添加对虚拟基本类缺失的支持（感谢Rapptz）。
C++，添加对最终课程的支持。
C++，修复了对前缀为“”的类型的解析。
#2023：荷兰搜索支持使用丹麦词干信息。
C++，添加对用户定义文字的支持。
#1804：现在html输出会在侧边栏中包装溢出的长行文本。感谢哈森·本·坦福斯。
#2183：修复porterstemmer原因 make json 失败。
#1899：确保列表已发送到OptParse。
#2164：修复sphinx.sty（对于graphicx包选项）内对pdftex的错误检查。
#2165、#2218：从phinx.sty中删除有缺陷且不需要的条件。
修复如果给定未知语言，则会生成损坏的LaTeX代码
#1944：修复rst_prolog中断文件范围的元数据
#2074：make gettext应该使用. pot的规范相对路径。感谢阿纳托利·泰克托尼克。
#2311：修复sphinx.ext.继承_diagram引发AttribeRight
#2251：.rst文件中的断点以错误的方式传输到.pot文件。
#794：修复乳胶输出中的日期格式未本地化
去除 image/gif 来自LaTeX writer的supported_Image_types（#2272）
修复如果LANGUAGE为空字符串，则引发Value错误
修复当从 Sphinx.add_crossref_type 使用
默认的突出显示语言现在是 default . 这意味着如果可能的话，源代码将突出显示为Python 3（主要是Python 2的超集）。要恢复旧行为，请添加 highlight_language = "python" to conf.py.
#2329：如果源目录发生更改，则强制刷新环境。
#2331：修复代码块由dvi中的块填充;删除 xcdraw xColor包中的选项
修复如果将unicode提供给需要字符串值的Confals，Confval类型检查器会发出警告的问题
#2360：修复LaTeX输出中的numref损坏
#2361：修复“compound”指令内的其他段落是锯齿状的
#2364：修复从旧版本升级的Sphinx上的Key错误“rootSymbol”。
#2348：将amsmath和amssymb移至LaTeX writer上fontpkg之前。
#2368：忽略emacs锁定文件，例如 .#foo.rst 在默认情况下
#2262：litial_bank及其标题已在LaTeX输出中通过页面分隔。
#2319：修复LaTeX中的代码块覆盖表计数器。感谢jfbu。
如果与第三方域名扩展结合使用，修复解包警告。
#1153：修复侧边栏中的数字会导致乳胶构建错误。
#2358：修复用户前置码无法覆盖tocdepth定义。
#2358：如果出现以下情况，则减少tocdepth part 或 chapter 用于top_sectionlevel
#2351：固定脚注间距
#2363：修复 toctree() 在模板中会在SingleHTMLBuilder中生成断开的链接。
#2366：修复HTML生成器中的toctree上生成空Hyperref。

文件¶

#1757：修复使用 html_last_updated_fmt .感谢Ralf Hemmecke。