Sphinx 0.3

发布 0.3 (2008年5月6日)

新增功能

  • The toctree directive now supports a glob option that allows glob-style entries in the content.

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

  • 一个新的配置值 exclude_dirs 可用于在搜索源文件时排除整个目录.

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

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

  • 新的配置值 latex_use_parts 可用于在 LaTeX 文档中启用部分.

  • Autodoc 现在跳过类的继承成员,除非你给出新的 inherited-members 选项.

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

  • 支持在C函数描述中使用C++类名(形式为 Class::Function ).

  • latex_documents 配置值的项中支持 toctree_only 项.这仅包括输出中 TOC 树引用的文档,而不是包含指令的其余文件.

修复的错误

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

  • sphinx.ext.autodoc:描述符现在被正确检测.

  • sphinx.latexwriter: 实现所有 reST 警告,而不仅仅是 notewarning .

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

  • 修复 OpenSearch 模板并使模板 URL 绝对化. html_use_opensearch 配置值现在必须提供基础 URL.

  • 一些未使用的文件现在已从HTML帮助文件构建中剥离.