Sphinx 0.3

版本 0.3 (2008年5月6日)

新增功能

  • toctree 指令现在支持 glob 选项,允许内容中使用 glob 风格的条目。

  • 如果 pygments_style 配置值包含一个点,它将被视为自定义 Pygments 样式类的导入路径。

  • 一个新的配置值 exclude_dirs 可用于从源文件搜索中排除整个目录。

  • 配置目录(包含 conf.py)现在可以独立于源目录设置。为此,添加了一个新的命令行选项 -c

  • 一个新的指令 tabularcolumns 可用于为 LaTeX 输出提供表格列规范。表格现在使用 tabulary 包。字面块现在可以放置在表格中,但有一些注意事项。

  • 一个新的配置值 latex_use_parts 可用于在 LaTeX 文档中启用部分(parts)。

  • 除非您提供新的 inherited-members 选项,否则 Autodoc 现在会跳过类的继承成员。

  • 一个新的配置值 autoclass_content,用于选择是否将类的 __init__ 方法的文档字符串添加到指令的主体中。

  • 在 C 函数描述中支持 C++ 类名(Class::Function 风格)。

  • 支持 latex_documents 配置值中的 toctree_only 项。这只包括输出中由 TOC 树引用的文档,而不包括包含指令的文件的其余部分。

修复的 Bug

  • sphinx.htmlwriter: 正确编写主文档任何结构的 TOC 文件。同时在 TOC 和索引文件中将非 ASCII 字符编码为实体。删除了两个剩余的硬编码“documentation”实例。

  • sphinx.ext.autodoc: 描述符现在可以正确检测。

  • sphinx.latexwriter: 实现所有 reST 训诫(admonitions),而不仅仅是 notewarning

  • 对 LaTeX 输出和样式进行了许多小修复。

  • 修复 OpenSearch 模板并使模板 URL 成为绝对路径。html_use_opensearch 配置值现在必须提供基本 URL。

  • 一些未使用的文件现在已从 HTML 帮助文件构建中删除。