Sphinx1.3¶
版本1.3.6（2016年2月29日发布）¶
功能添加¶
#1873、#1876、#2278：添加
page_source_suffixhtml上下文变量。这一点应与source_parsers功能.感谢埃里克·霍尔舍尔。
错误已修复¶
#2265：尽管禁用了巴别塔，但仍使用它
latex_elements#2295：使用Python 3在autodoc中列举成员时避免变异字典错误
#2291：修复目录内脚注中的pdflatex“计数器太大”错误
#2292：修复LaTeX输出中一些脚注消失的问题
#2287：
sphinx.transforms.Locale始终使用rst解析器。Sphinx i18 n功能应支持指定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 builder在parsed-literal包含链接时引发错误的问题
#2243：忽略类的奇怪文档字符串类型，不要崩溃
#2247：修复#2205中断为定义列表创建html，该列表包含包含字符串等规则表达的分类器
#1565：如果语法不正确，Sphinx现在将发出警告，表明已跳过突出显示
code-block,literalinclude等#2211：修复表格单元格中的段落在Latex输出中不起作用
#2253：
:pyobject:选择literalinclude当块以空白或注释行开头时，指令无法检测到缩入的主体块。当否时，修复目录不会显示
:maxdepth:对于toctree（参考号：#771）修复警告消息
:numref:如果目标位于孤立文档中（参考号：#2244）
版本1.3.4（2016年1月12日发布）¶
错误已修复¶
#2134：修复带有参考的图形标题导致乳胶构建错误
#2094：修复参考在Latex中不起作用的标题
#2147：修复乳胶中的文本包含代码不会在页面中中断
#1833：修复如果latex_show_urls不显示，电子邮件地址将再次显示
None#2176：phinx.ext.graphviz：使用<object>而不是<img>嵌入svg
#967：修复SVG继承图没有超链接（可点击）
#1237：修复LaTeX中定义列表中不起作用的脚注
#2168：修复原始指令不适用于文本编写器
#2171：修复无法链接检查url与unicode
#2182：LaTeX：支持超过1个点的图像文件名
#2189：修复收件箱中第一个文件的先前同级链接使用最后一个文件，而不是来自根toctree的先前文件
#2003：修复python 2下的解码错误（仅）当
make linkcheck运行#2186：在数学中修复mathbb的LaTeX输出
#1480、#2188：LaTeX：支持部分标题中的数学
#2071：修复两个以上部分标题中的相同脚注=> LaTeX/PDF漏洞
#2040：修复作者包含非ASC字符时phinx-apidoc中的UnicodeDecode错误
#2193：修复源目录和目标目录相同时shutil.SameFileError错误
#2178：修复引用函数时不可解析的C++交叉引用
:cpp:any:#2206：修复因脚注而导致的Sphinx乳胶文档构建失败
#2201：修复超过30行的表的错误表标题
#2213：以<blockquote>经典主题为背景，以适应<p>
#1815：修复如果warniserror设置为true并且链接断开，linkcheck不会引发异常的问题
#2197：修复丢失index.rst文件的稍微神秘的错误消息
#1894：快速启动Maketime中未列出的虚假目标
#2125：修复统一崩溃字段的行为 (
GroupedField和TypedField)#1408：复制之前检查latex_徽标的有效性
#771：修复乳胶输出未设置为深度
#1820：在Windows上，colorama版本0.3.3打破了控制台着色。现在Sphinx使用colorama>=0.3.5来避免这个问题。
#2072：修复章节中的脚注-标题未出现在PDF输出中
#1580：修复长表中的段落在Latex输出中不起作用
#1366：修复中心图像未以乳胶为中心
#1860：使用修复手册页
:samp:带大括号-字体不会重置#1610：Sphinx在某些系统中的日语索引中崩溃
修复如果mecab初始化失败，Sphinx崩溃的问题
#2160：如果部分包含图像，修复PDF损坏的目录
#2172：修复功能失调的警告
\py@lightboxin phinx.sty。感谢jfbu。#2198、#2205：
make gettext为定义列表生成损坏的msgid。#2062：Python 2对doctests中的Escape字符处理不当。
#2225：修复如果选项不以破折号开头，则不执行链接
#2226：修复当给出：nowrap：时数学未被HTML编码（jsmath，mathspel）
#1601、#2220：“任何”角色会破坏扩展域行为。受影响的扩展不支持resolve_any_xref，并且resolve_xref返回有问题的节点，而不是
None. phinxcontrib-httpdomain就是其中之一。#2229：修复未知选项未发出警告
版本1.3.3（2015年12月2日发布）¶
错误已修复¶
#2177：修复平行悬挂
#2012：修复出现异常
numfig_format无效#2142：提供非精简的JS代码
sphinx/search/non-minified-js/*.js在PyPI上发布源代码。#2148：使用非ASC文档构建DevHelp目标时出错。
版本1.3.2（2015年11月29日发布）¶
功能添加¶
#1935：使“numfig_form”在latex_elements中可重写。
错误已修复¶
#1976：避免使用“2.0”版本的Babel，因为它不适用于Windows环境。
添加“default.css”样式表（导入“classic.css”）以实现兼容性
#1788：当存在标题选项时，graphviz扩展会引发异常。
#1789：
:pyobject:选择literalinclude指令在类定义之后包括以下行#1790：
literalinclude去掉头部和尾部的空线#1802：当theme.inf使用插件主题作为“继承”时，自动加载插件主题。感谢平井隆之。
#1794：自定义主题扩展自
alabaster或sphinx_rtd_theme找不到基本主题。#1834：Docutils 0.13的兼容性：docutils.io.文件的handle_io_errors关键字参数输入导致TypHelp。
#1823：'。'至于<module_path>Sphinx-apidoc会导致一个不友好的错误。现在'。'自动转换为绝对路径。
修复设置不支持元数据的扩展时发生的崩溃。
#1784：在中提供非精简JS代码
sphinx/search/non-minified-js/*.js#1822、#1892：修复#1061的回归。自Sphinx 1.3b3以来，自动摘要无法为导入的成员生成文档。感谢埃里克·拉尔森。
#1793、#1819：“请参阅”在文本输出中错过了一个断点。感谢平井隆之。
#1780、#1866：“make text”显示“class”关键字两次。感谢平井隆之。
#1871：修复具有一列和多行的表的LaTeX输出。
解决Python 3.5中缺乏HTMLParser错误异常的问题。
#1949：使用
safe_getattr以避免使用具有自定义行为的描述符而中止。#1915：不要在文档字段类型注释中生成智能引号。
#1796：在py 3上，自动构建.mo导致UnicodeDecode错误。
#1923：仅在巴别乳胶元素非空时才使用巴别特功能。
#1942：修复网络支持中的Key错误。
#1903：修复术语表术语的奇怪id生成。
make text如果定义列表项具有超过1个分类器，则会崩溃：term : classifier1 : classifier2.#1855：make gettext为具有分类器的定义列表生成损坏的po文件。
#1869：修复处理包含非ASC字符的文件时的问题。感谢马文·施密特。
#1798：修复在标题中使用引用构建LaTeX的问题。
#1725：在py 2环境中，使用非ASC字符的docTest导致
'ascii' codec can't decode byte例外.#1540：通过循环引用toctree修复运行时错误
#1983：i18n翻译功能中断使用节名的引用。
#1990：在LaTeX中使用toctree的标题作为tableofcontents的标题
#1987：修复与符号被忽略在
:menuselection:和:guilabel:在LaTeX制造商上#1994：更多支持翻译和网络支持功能的非标准解析器（如recommonmark解析器）。现在，在Docutils转换期间，node.rawsource会备份到node.astext（）。
#1989：Windows上的“make blahblah”每次都表示sphinx构建的帮助消息。 这是由于Sphinx 1.3.0/1.3.1生成的make. mat错误引起的。
在Py 2环境中，由phinx-quickstart生成的conf.py应该具有“版本”和“release”以u为开头的配置值。
#2102：在Windows + Py3上，使用
|today|而非ASC日期格式将引发UnicodeEncodeMessage错误。#1974：UnboundLocal错误：使用时在分配之前引用了局部变量“域”
any作用和sphinx.ext.intersphinx同时。#2121：当单词在页面标题和页面内容上交叉时，多单词搜索找不到页面。
#1884、#1885：插件html主题无法继承其他插件主题。感谢铃木崎。
#1818：
sphinx.ext.todo指令生成损坏的html类属性作为“警告-”时language使用非ASC语言区域指定，例如“ru”或“ja”。现在就解决这个问题todo指令可以使用:class:选项.#2140：修复LaTeX中表格中的脚注已损坏
#2127：MecabBinder的html搜索功能不适用于Python 3。感谢内田智子。
版本1.3.1（2015年3月17日发布）¶
错误已修复¶
#1769：允许为目标目录生成快速启动文件/目录，不会覆盖现有的文件/目录。感谢和山四郎。
#1773：sphinx-quickstart不接受非ASCII字符作为选项参数。
#1766：“最少运行Python 2.6”的消息充其量只是误导。
#1772：文档字符串中的交叉引用，例如
:param .write:打破建筑。#1770、#1774：
literalinclude空文件发生异常。感谢平井隆之。#1777：Sphinx 1.3无法加载额外的主题。感谢tell-k。
#1776：
source_suffix = ['.rst']在早期版本上导致不友好的错误。#1771：自动化的.mo构建无法正常工作。
#1783：Autodoc：Python2允许使用unicode字符串
__all__.感谢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的
source_suffix配置值现在可以是多个后缀的列表。添加通过源后缀指定源解析器的功能
source_parsers配置值。#1675：添加了一个新的构建器AppleHelpBuilder，用于构建Apple帮助书籍。
错误已修复¶
1.3b3更改打破了之前的gettext输出，该输出包含重复的msgid，例如“foo bar”和“1.3：foo bar中的版本更改”。
#1745：当脚注本身有脚注标记时，乳胶助溶剂会导致超过最大回归深度。
#1748：Python 2.6中的phinx/ext/ifconfig.py中的语法错误。
#1658、#1750：如果选项不是以-、/或+开头，则不会创建链接（并给出警告）。感谢平井隆之。
#1753：C++，增加了对更复杂声明的支持。
#1700：添加
:caption:选择toctree.一七四二：
:name:提供了选项toctree,code-block和literalinclude指令。#1756：从1.3b3中引入的搜索中的部分标题不正确。
#1746：C++，固定名称查找过程，并在声明中添加了缺失的查找。
#1765：C++，修复旧id生成使用完全限定名称的问题。
文件¶
#1651：添加
vartypepython域的字段描述。
版本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：添加新的默认主题;
添加“雪花石膏”主题。
添加“' sphinx_rtd_theme ''主题。
“default”html主题已重命名为“classic”。“default”仍然可用，但它会发出通知，建议使用新的“雪花石膏”主题。
添加
highlight_options配置值。的
language配置值现在可在HTML模板中使用。的
env-updated事件现在可以返回一个值，该值被解释为需要重写的额外文档名的可迭代对象。#772：C++中支持有作用域和无作用域的枚举。除了enum范围之外，无作用域的enum中的分母还被注入到父范围中。
添加
todo_include_todos快速启动配置文件的配置选项，按文档中所述处理。HTML breadcrumb items标签具有类“nav-entry”和“nav-entry-N”（例如nav-entry-0、1、2.）。
新选项
sphinx-quickstart --use-make-mode用于生成使用Sphinx构建make-mode的Makeline。#1235：i18 n：如果设置为，则可以翻译多个节点
gettext_additional_targets在Conf.py中。支持的节点有：“文字块”
“doctest-Block”
“生的”
“形象”
第1227章：一夜情
html_scaled_image_linkconf.py的配置选项，以控制缩放的图像链接。
错误已修复¶
LaTeX编写器现在为跨越多行的单元格生成正确的标记。
#1674：如果模块的故障，请勿崩溃
__all__不是字符串列表。#1629：使用VerbatimBorderColor将帧添加到LaTeX中的代码块
在Windows上，如果Sphinx被调用为，make-mode在Win32平台上不起作用
python sphinx-build.py.#1687：linkcheck现在将401未经授权的响应视为“正在工作”。
#1690：toctree与
glob选项现在还可以包含具有显式标题的单个文档的条目。#1591：C++元素的html搜索结果现在具有正确的插页链接。
bizstyle主题：嵌套的长标题页面使长breadcrumb打破页面布局。
bizstyle主题：在某些移动浏览器（iPhone5s safari）上，所有breadcrumb项目都成为“Top”。
#1722：恢复
toctree()在1.3b1更改的模板函数行为。#1732：i18n：localized table caption raises exception.
一七一八号：
: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日发布）¶
不兼容的更改¶
更新需要Python 2.6或更高版本的setuptools-7.0的捆绑ez_set.py。
功能添加¶
#1597：添加了从返回新模板名称的可能性
html-page-context.PR#314、#1150：现在检查配置值的类型。 如果配置的值和默认值的类型不相同并且不共享公共的非平凡Base，则会引发警告。
错误已修复¶
PR#311：phinx-quickstart不适用于Python 3.4。
修复
autodoc_docstring_signature不处理类文档字符串中的签名。添加源文件时，重建导致意外崩溃。
#1607：修复使用“howto”类构建latexpdf时的崩溃
#1251：再次修复。深度低于：tocdepth：的部分不应显示在localtoc侧边栏上。
如果通过wheel包安装Sphinx，make-mode在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以发出uid信息。此外，如果python-levenshtein安装第三方包，将缩短计算时间。gettext builder：默认情况下禁用提取/应用“index”节点。请将“index”设置为
gettext_enables以启用提取索引条目。PR#307：将帧添加到LaTeX中的代码块。感谢小宫武。
功能添加¶
添加对Python 3.4的支持。
添加对Docutils 0.12的支持
添加
sphinx.ext.napoleonNumPy和Google风格文档字符串支持的扩展。添加了对并行读取（解析）源文件的支持
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的文档字段。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。提示输入phinx-quickstart中的文档语言。
PR#217：添加了配置值以抑制生成的gettext目录中的UID和位置信息。
PR#236，#1456：apidoc：添加-M选项以将模块文档放在子模块文档之前。感谢Wes Turner和Luc Saffre
#1434：为jquery.js和undersscore.js提供非小型JS文件，以澄清小型文件的来源。
PR#252、#1291：Windows彩色控制台支持。感谢meu 31。
PR#255：生成乳胶引用时，还要为节点上定义的id插入乳胶目标/锚点。感谢Olivier Heurtier。
PR#229：允许其他翻译人员注册。感谢Russell Sim。
添加app.set_translator（）API来注册或重写Docutils翻译器类，例如
html_translator_class.PR#267、#1134：将“diff”参数添加到字面包含中。感谢理查德·沃尔和若山四郎。
PR#272：添加了“bizstyle”主题。感谢Shoji KUMAGAI。
自动编译
*.mo文件从*.po文件时gettext_auto_build是True（默认）和*.po新于*.mo文件.#623：
sphinx.ext.viewcode支持导入的函数/类别名。PR#275：
sphinx.ext.intersphinx支持库存的多个目标。感谢Brigitta Sipocz。PR#261：添加了
env-before-read-docs可以连接该事件以在环境读取文档之前修改文档顺序。#1284：记录了程序选项
option现在可以从+.第291章：我的天
code-block被认为是裁判目标的标题。感谢小宫武。PR #298：添加新API：
add_latex_package().感谢小宫武。#1344：添加
gettext_enables启用将“index”提取到gettext目录输出/将翻译目录应用到生成的文档。PR#301、#1583：允许指令的行编号
literalinclude要匹配包含的文件，请使用新的lineno-match选项.感谢Jeppe Pihl。PR#299：将各种选项添加到sphinx-quickstart。安静模式选项
--quiet将跳过向导模式。感谢和山四郎。#1623：返回指定的类型
:rtype:如果可能的话，现在都变成了链接。
错误已修复¶
#1438：更新jQuery版本从1.8.3到1.11.1。
#1568：修复“居中”指令包含引用时的崩溃。
现在phinx.ext.autodoc再次与python-2.5一起工作。
#1563：
add_search_language()引发AssertionMessage以获取正确的参数类型。感谢理科曼。#1174：修复在角色内部应用的智能引言，例如
program或makevar.PR#235：webSupport的注释数据库模式缺乏note_id字段的长度。感谢独奏。
#1466，PR#241：修复cpp域解析器无法解析C+11“可变模板”声明。感谢维克多·兹韦罗维奇。
#1459，PR#244：修复默认的mathspreadjs路径指向
http://这会导致HTTPS服务器上出现混合内容错误。感谢sbrandtb和robo9k。PR#157：autodoc从@Property装饰属性中删除虚假签名。感谢大卫·汉姆。
PR#159：将覆盖目标添加到快速启动生成的Makefile和make.bat。感谢Matthias Troffaes。
#1251：当指定toctree：numbered：option和：tocdepth：metadata时，深度大于
:tocdepth:缩小了。PR#260：在乳胶出口的引用标签中编码强调线。感谢伦纳特·弗里克。
PR#264：修复无法用：名称：选项解析图形节点的外部参考。感谢小宫武。
PR#265：修复无法通过xref捕获graphviz节点的标题。感谢小宫武。
PR#263、#1013、#1103：重写C++域。感谢雅各布·莱克·安德森。
指向所有找到的嵌套名称和模板参数的超链接（#1103）。
支持无处不在的功能类型，例如，在std：：函数<bool（int，int）>（#1013）中。
支持虚拟功能。
将函数参数的解释更改为遵循标准原型声明，即val f（arg）意味着arg是参数的类型，而不是名称。
更新了测试。
更新了文档，详细描述了支持哪些声明以及命名空间声明如何影响声明和交叉引用查找。
现在索引名称可能有所不同。元素通过其完全限定名称进行索引。改变这种行为应该相当容易，并且还可能通过名称空间/类进行索引。
PR#258、#939：添加dent选项
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指令下，则修复节条目显示两次的问题。感谢小宫武。
#1547：pgen 2标记器无法识别
...字面意思（py 3的省略号）。PR#294：在LaTeX构建器上，在写入litical_块时包裹float环境，以避免标题和正文分离。感谢小宫武。
PR#295、#1520：
make.bat latexpdf机制cd返回到当前目录。感谢彼得·苏特。PR#297、#1571：将imgPATH属性添加到所有构建器。它使开发构建器扩展变得更容易。感谢小宫武。
#1584：指向HTML“顶部”链接中的主文档。
#1585：Sphinx 1.2.3中损坏的模块的自动摘要。
#1610：当MeCab搜索选项被启用且未安装python-mecab时，Sphinx会导致Veritas错误。
#1674：如果模块的故障，请勿崩溃
__all__不是字符串列表。#1673：修复崩溃
nitpick_ignore和:doc:参考资料。#1686：ifconnect指令不关心默认配置值。
#1642：修复Chrome中只显示一个搜索结果。
文件¶
添加有关标签语法的说明。 (
doc/markup/misc.rst)