Sphinx

当首次创建的，它的主要目的是作为的Python 自己的代码文档生成。
自那时以来，该项目已达到了世界发展的崇拜状态，是一个最有参考的影响，在各地的大多数自动文档生成器，无论语言。
如今，除了刚才的Python，狮身人面像，也可以使用C和C ++代码。

什么在此版本中是新的

• 将便利指令和角色到C ++域：指令``CPP：var``作为别名``CPP：member``，角色``：CPP：var``作为别名``：CPP：成员``和`角色为any`交叉引用到任何C ++ declaraction。
• 的：confval：​​`现在source_suffix`配置值可以是多个后缀的列表
。
• 将通过源后缀与指定源解析器的能力：confval：​​`source_parsers`配置值
• 在一个新的建设者，AppleHelpBuilder，已经加入了苹果公司建立图书的帮助。

在什么版本的新 1.2.3 / 1.3b3：

• 新增``sphinx.version_info``元组的狮身人面像的版本纲领性检查。

在什么版本1.1.3新是

• 修正了与一些设置：confval：​​`modindex_common_prefix`
• 修正处理``-D``和``-A``选择了Python 3。
• 识别和警告，而不是运行到递归误差有关循环toctrees。
• 恢复兼容docutils的树干。
• 固定HtmlHelp的索引条目链接了。
• 修正inheritance_diagram上建宏提高属性的错误。

把意见或独行条款时，在词汇表
• 修正了崩溃。
• 固定的HTML帮助语言/编码映射狮身人面像所有支持的语言。

在什么版本1.1是新的

• 功能的加入：
• 新增的Python 3.x的支持。
• 新的建设者和子系统。
• 在不兼容的变化：
• 的：RST：DIR：`PY：module`指令不输出它的``platform``选项的值了。 （这是唯一的指令做输出，因此颇不一致。）
• 删除了旧版本的相关支持。
• 新的语言环境：
• 新增瑞典语语言环境。
• 补充伊朗的语言环境。
• 添加拉脱维亚语言环境。
• 新增尼泊尔语言环境。
• 添加韩文语言环境。
• 添加爱沙尼亚的语言环境。

在什么版本1.0.8新是

• 修正回溯在自动摘要代AttributeErrors。
• 修正了``abbr``角色时的缩写具有换行符在里面。
• 修正的链接，搜索与自定义对象类型的结果。

在报告关于未定义的引用警告
• 修正行号。
• 修正C ++数组定义和模板参数未键入名称。
• 允许在节头脚注LaTeX的输出。
• 允许关键字通过intersphinx链接。
• 允许在生产列表标记名称的Unicode字符。
• 将虚拟游客文本和人graphviz的节点。
• 修正图像文件的复制错误。

多个签名的C ++域
• 修正解析。
• 查找源文件时，忽略Emacs的锁文件。
• 允许.pyw扩展在车博士导入的模块。
• 使用``$在快速入门生成生成文件（MAKE）``。
• 请在浏览器侧边栏搜索框的宽度一致。
• 修正的HTML输出中心数字间距。
• 在打印时，它们编码安全信息SphinxError在sys.stderr。
• 修正LaTeX的输出误差与不部分的文档，但链接的目标。
• 在正确对待内置的方法描述为在车博士的方法。
• 停止的monkeypatching Python的textwrap模块。
• Viewcode现在有非ASCII编码的源文件可以正常工作。
• 在尊重PY中的``noindex``标志选项：模块指令

RST：DIR：
• 在其中不存在的线，当修复IndexErrors。`literalinclude`
• 在尊重自定义函数/方法的参数字符串分隔。
• 修正JS不兼容与jQuery＆GT;。= 1.5
• 写的HTMLHelp .hhk文件时修复完成双重编码。
• 请不要在解析字面块适用SmartyPants。
• 在C ++领域现在支持数组的定义。

在什么版本1.0.6新是

• 修正回溯的空交叉引用目标的Python域。
• 修正文字块显示屏上的问题的Chrome浏览器。
• 支持在总指数和词汇的排序重音字符范围有限。
• 尝试解码``-D``和``-A``命令行参数的语言环境的首选编码。
• 注意：confval：​​`locale_dirs`找JS翻译文件时
• 将特殊的代码更好的支持，在建设者的LaTeX文档日本人
• 的＃77回归：如果没有与``只给出了一个参数：参数：``标记，子弹名单现在又抑制
• 修正了在某些情况下，LaTeX输出缺段中断。
• 发出``车博士 - 过程 - docstring``事件即使对象而不文档字符串，以便它可以添加内容。
• 在LaTeX的建设者，不仅文字块需要不同的表处理，而且还不少其他类似列表的块元素。
• 修正回溯在viewcode扩展Python对象没有一个有效的签名。
• 修正行号的怪reportings从车博士 - 包括文档字符串，因为这取决于docutils的版本不同的行为所产生的警告。
• 若干修正到C ++域。

在什么版本1.0.5新是

• 将通过docutils的0.7对准的图像和数字所需的CSS样式。
• 在Makefile中乳胶输出生成，不删除干净的PDF文件;他们可能需要的图像。
• 线路块生成修复LaTeX的输出。
• 允许``.pyw``作为源文件的扩展名。

在什么版本1.0.4是新的

• 开启intersphinx库存在Windows二进制模式，因为第2版中包含的zlib压缩数据。
• 允许给非本地的URI的JavaScript文件，如在JSMath扩展。
• 修正回溯时``intersphinx_mapping``是空的。

在什么版本1.0.3新是

• 修正与内部的链接从docutils的表中，今后内容的外部链接的区别。
• 修正了``maxdepth``选项为``toctree（）``和`使用时可调用模板坍塌`= True``。
• 修正崩溃的解析括号包含在字符串的Python参数列表。
• LaTeX的建设与文档没有字幕的数字时，修复回归。
• 修正的继承图的类未picklable。
• 在实施分开背景颜色侧边栏折叠按钮，使其更容易看到的。
• 修正的小虫子布局的几个内置的主题。

在什么版本1.0.2是新的

• 修正交叉引用到所添加的对象类型：FUNC：`〜.Sphinx.add_object_type` API函数
• 修正文档字段类型不同的指令类型的操作。
• 允许打破长的签名，与间隙转义换行符继续。
• 修正（因为一个命名空间冲突与Pygments风格）C域引用不必要的造型。
• 允许引用政治公众人物和RFC中有明确的锚。
• 修正LaTeX的参考数字。
• 当执行非精确搜索，仅匹配给定类型的对象。
• 申请Python的参考指标非精确搜索与``.name``的模块了。
• 在复制时，在一个信息字段列表参数修正崩溃。
• 修正设定的默认角色之一的``oldcmarkup``扩展提供。
• 在安装JSON-PY修复时崩溃，它提供了一个``json``模块，但不兼容于simplejson。
• 修正的intersphinx目标命名操作。
• 修正去除``的！``所有交叉引用的角色。

在什么版本1.0.1是新的

• 修正休息域对象生成的目标名称;它们不在相同的命名空间。
• 将孟加拉语。
• 修正了解析JavaScript对象名称的错误。
• 修正建设有SingleHTMLBuilder时，有没有toctree。
• 修正显示名称与明确的目标挂钩由intersphinx对象。
• 修正带建设的JSON生成器。
• 修正hyperrefs对象的描述LaTeX的。

什么版本1.0是新的

• 常规：
• 添加了一个“挑剔”模式，发射所有失踪引用警告。选项​​：`-n`命令行开关或：confval：​​这是由激活。`nitpicky`配置值
• 在快速启动加``latexpdf``目标Makefile文件。
• 标记：
• 的：RST：角色：`menuselection`和：RST：角色：`guilabel`角色现在支持符号加速器
• 在新的更紧凑的DOC场语法是目前公认：``：参数类型名称：description``
• 新增``制表width``选项：RST：DIR：`literalinclude`指令
• 新增``titlesonly``选项：RST：DIR：`toctree`指令
• 添加了``prepend``和``append``选择到：RST：DIR：`literalinclude`指令
• 所有文档信息元数据现在放入文档元数据，而不仅仅是作家。
• 的：RST：角色：`ref`作用，现在还可以通过标题引用表
。
• 的：RST：DIR：`include`指令现在支持绝对路径，它被解释为相对于源目录
• 在Python的领域，如``参考资料：FUNC：`.name```现在看起来与任何前缀，如果没有直接找到匹配匹配的名字
• 配置：
• 新增：confval：​​`rst_prolog`配置值
• 新增：confval：​​`html_secnumber_suffix`配置值，以控制部分编号格式为：
• 新增：confval：​​`html_compact_lists`配置值来控制docutils的“紧凑列表功能
• 的：confval：​​`html_sidebars`配置值现在可以包含模式作为键和值可以是列出了明确选择其中的侧边栏模板应该呈现。这意味着，内建的侧边栏内容可以只选择性地包括在内。
• ：confval：​​`html_static_path`现在可以包含单个文件条目
• 在新的通用配置值：confval：​​`exclude_patterns`使老：confval：​​`unused_docs`，：confval：​​`exclude_trees`和：confval：​​`exclude_dirnames`过时
• 新增：confval：​​`html_output_encoding`配置值
• 添加了：confval：​​`latex_docclass`配置价值，并提出了“twoside”的DocumentClass选项重写的“oneside”
。
• 添加了：confval：​​`trim_doctest_flags`配置价值，这是真正的默认
• 新增：confval：​​`html_show_copyright`配置值
• 新增：confval：​​`latex_show_pagerefs`和：confval：​​`latex_show_urls`配置值
• 的行为：confval：​​`html_file_suffix`略有变化：空字符串现在的意思是“没有后缀”，而不是“默认后缀”，使用``None``为“默认后缀”
。
• 新建设者：
• 添加了建设者的EPUB格式。
• 添加了一个建设者手册页。
• 添加单个文件的HTML生成器。
• HTML输出：
• 内联的角色现在得到一个CSS类与他们的名字，让样式自定义它们的外观。域特定的角色得到两班，``domain``和``域rolename``。
• 引用现在得到的类``internal``如果他们内部的整个项目，而不是内部的当前页面。
• 外部引用可以与新的``externalrefs``主题为默认的主题选项不同的样式。
• 在默认的主题，侧边栏可以实验现在可以使用新的``collapsiblesidebar``主题选项时可折叠。
• Toctrees现在裹着``div``带班``toctree-wrapper``在HTML输出标记。
• 的：数据：`toctree`调用模板现在有一个``maxdepth``关键字参数来控制生成的树的深度
• 的：数据：`toctree`调用模板现在接受``titles_only``关键字参数
• 新增``htmltitle``块布局模板。
• 在JavaScript的搜索，让搜索对象名称包括模块名称，如``sys.argv``。
• 添加新的主题``haiku``，灵感来自俳句操作系统用户指南。
• 添加新的主题``nature``。
• 添加新的主题``agogo``，由安迪阿尔布雷希创建。
• 添加新的主题``scrolls``，由阿明Ronacher创建。
• 添加了``visitedlinkcolor``主题选项默认主题。
• 在搜索页面的改进响应异步通过加载thesearch指数。
• 扩展API：
• 补充：事件：`HTML - 收集 - pages`
• 新增：confval：​​`needs_sphinx`配置值和：甲：`〜sphinx.application.Sphinx.require_sphinx`应用程序API方法
• 补充：甲：`〜sphinx.application.Sphinx.add_stylesheet`应用程序API方法
• 扩展：
• 添加了：MOD：`〜sphinx.ext.viewcode`扩展
。
• 添加了：MOD：`〜sphinx.ext.extlinks`扩展
。
• 增加了对车博士成员源排序支持，``autodoc_member_order ='bysource'``。
• 新增：confval：​​`autodoc_default_flags`配置值，可用于选择默认的标志车博士所有指令
• 添加一种方式intersphinx指在其他项目命名的标签，并指定要链接到项目中。
• 车博士现在可以记录例如在``__init__``方法属性分配。
• 很多改进和修正至：MOD：`〜sphinx.ext.autosummary`扩展，这要归功于保利维尔塔宁
• 的：MOD：`〜sphinx.ext.graphviz`扩展现在可以输出SVG，而不是PNG图像，由co​​nfval控制：`graphviz_output_format`配置值
• 新增``alt``选项：RST：DIR：`graphviz`扩展指令
• 新增``exclude``参数：FUNC：`.autodoc.between`
• 翻译：
• 新增 - 克罗地亚语翻译，感谢博扬Mihelac。
• 新增土耳其语翻译，感谢的Firat厄兹居尔。
• 新增加泰罗尼亚语翻译，这要归功于保罗·费尔南德斯。
• 新增简体中国的翻译。
• 新增丹麦的翻译，感谢Hjorth拉森。
• 新增 - 立陶宛语翻译，感谢Dalius Dobravolskas。

什么版本1.0b1是新的

• 支持域名已被添加。域是指令，所有描述对象属于一起，例如角色的集合编程语言元素。提供了一些内置的域： - Python的 - C - C ++ - 的JavaScript - 新结构化
• 旧标记定义和连接到C指令将不会在不激活的``oldcmarkup``延长工作了。
• 删除了旧版本的相关支持。
• 删除过时的元素。

在什么版本0.6.5新是

• 在车博士，修正遗漏的某些模块成员使用文档注释明确记载。
• 修正侧边栏滚动条的裁剪与``的默认主题stickysidebar``选项。
• 始终生成UNIX换行符在快速入门的Makefile。
• 修正了``-C`` Windows下运行。
• 在车博士，允许自定义对象，其中内置的机制失效的签名。
• 修正输出与初始值在LaTeX的枚举列表。
• 请了``启动after``和``最终before``选项给``literalinclude``指令正常工作，如果不一起使用。
• 修正链接产生的LaTeX的建设者。

在什么版本0.6.4新是

• 改进的非Unicode字符串在配置的处理。
• 赶上OSErrors出现带参数不明白调用时graphviz的。
• 恢复兼容Pygments＆GT;。= 1.2
• 修正了LaTeX的输出转义的目标hyperref宏

``作用LaTeX的输出：DOC：由``生成
• 修复链接。
• 收集待办事项节点在整个文档已被读取之后;这允许将替换在引用的待办事项。
• 请不要忽视了一个明确的``today``配置在胶乳创造价值。
• 继承图的``alt``文本现在干净多了。
• 在生成的链接标题时忽略的章节标题图片。
• 支持异常消息在``doctest``扩展的``testoutput``块。
• 行块在正确HTML输出风格。
• 再次取得``locale_dirs``配置价值的工作。
• ``html_context``值给出通过``-A``不应该覆盖conf.py给其他值在命令行上。
• 修正了一个错误预防增量的重建为``dirhtml``建设者。
• 修正了一些文字块的报价是混淆。
• 修正路径为``dirhtml``建设者的搜索索引。
• 解决Jython的兼容性问题：使``parser``模块可选的依赖
。
• 在车博士，赶上了发生在模块的进口，而不只是``ImportError``。
所有的错误
• 修正非数据的处理，但非法描述在车博士。
• 当复制文件时，忽略（）```用`os.utime提出OSErrors。

要求

• Pygments 1.2或更高版本
• 在神社2.3或更高版本
• docutils的0/7或更高