Sphinx0.2¶

版本0.2（2008年4月27日）¶

不兼容的更改¶

Jinja是用于默认HTML模板的模板引擎，现在不再随Sphinx一起提供。如果它没有为您自动安装（它现在在中列为依赖项 setup.py ），从PyPI手动安装。如果您从SVN结账使用Sphinx，也需要这一点;在这种情况下，请还删除 sphinx/jinja 旧修订版可能留下的目录。
笨拙的处理 index.html 模板已删除。配置值 html_index 走了 html_additional_pages 应该改为使用。如果你需要，旧的 index.html 模板还在，称为 defindex.html ，并且您可以使用Jinja继承通过更改模板来移植您的html_index模板：：
```
{% extends "defindex.html" %}
{% block tables %}
... old html_index template content ...
{% endblock %}
```
将质量 'index': name of your template 在 html_additional_pages .
布局模板中，多余 block s已被删除;您应该使用Jinja的标准 {{ super() }} 相反，正如（新编写的）模板文档中所解释的那样。

新增的功能¶

扩展API（应用程序对象）：
- 支持一种新方法， add_crossref_type . 它的工作就像 add_description_unit 但该指令只会创建目标而不会创建输出。
- 支持一种新方法， add_transform . 需要标准的Docutils Transform 然后由Sphinx的阅读器应用它来解析reST文档树。
- 通过添加名为“模板桥”的抽象来添加对Jinja以外的其他模板引擎的支持。此类处理模板的渲染，并且可以使用新的配置值“template_bridge”进行更改。
- 配置文件本身可以是一个扩展（如果它提供了 setup() 功能）。
标记：
- 新指令， currentmodule . 它可以用于指示以下文档内容的模块名称，而无需创建索引条目。
- 允许为toctree中的文档指定不同的标题。
- 允许在 cmdoption 指令。
- 修复未给出明确的类名称的类成员的显示。
模板（HTML输出）：
- index.html 重命名为 defindex.html ，见上文。
- 有一个新的配置值， html_title ，它控制Sphinx文档集的总体“标题”。它现在在任何地方都被使用，而不是“Projectname vX.Y documentation”。
- 模板中对“文档”的所有引用都已被删除，这样现在可以更轻松地使用Sphinx来处理具有默认模板的非文档文档。
- 模板现在有一个XHTML文档类型，以与Docutils的HTML输出保持一致。
- 现在可以使用 html_use_opensearch 配置值。
- 您现在可以使用 html_logo 配置值。
- 侧边栏中有新块，以便您可以轻松地将内容插入侧边栏中。
LaTeX输出：
- 的 sphinx.sty 包裹中没有使用过的东西。
- 您可以在标题页中包含徽标，并带有 latex_logo 配置值。
- 您可以为逐字环境定义链接颜色以及边框和背景颜色。

感谢Jacob Kaplan-Moss、Talin、Jeroen Ruigrok van der Werven和Sebastian Wiesner的建议。

错误已修复¶

phinx.ext.autodoc：不要检查 __module__ 对于明确指定的成员。删除类构造函数参数列表中的“self”。
phinx.htmlwriter：不要使用os.路径来加入图像HRA。
phinx.htmlwriter：不要将SmartyPants用于HTML属性值。
phinx.latexwriter：实现选项列表。此外，还进行了一些其他更改 sphinx.sty 以增强兼容性并删除旧的未使用内容。感谢盖尔·瓦罗阔（Gael Varoquaux）！
phinx.roles：修复引用具有明确目标的术语表术语的问题。
环境：在解析子树时不要吞下TOC条目。
phinx.quickstart：创建合理的默认latex_documents设置。
phinx.builder，phinx. energy：优雅地处理一些用户错误案例。
phinx.util：搜索文档时遵循符号链接。