z3c.recipe.epydoc 0.0.3

简介

此构建脚本生成项目文档的epydoc文档

使用说明

假设你有一个名为ezineserver的包。在你的包的buildout.cfg文件中，添加一个类似这样的docs部分

[docs]
recipe = z3c.recipe.epydoc
eggs =
z3c.recipe.epydoc
ezineserver
doc = ezineserver

确保将其包含在部分中，如下所示

[buildout]
develop = .
parts = docs

现在你可以重新运行buildout。该配方将在bin目录中创建一个名为docs的可执行脚本。

此脚本将在你的源代码上运行epydoc文档生成工具。

要生成文档，只需运行docs脚本

$ ./bin/docs

这会为你生成所有文档，并将其放置在parts目录中。然后你可以在firefox中打开它查看

$ firefox parts/docs/index.html

就这样！

指定附加选项

还可以将附加epydoc选项传递给docs脚本（要获取所有可用选项的列表，请使用--help选项运行脚本）。

你可以通过两种不同的方式做这件事

• 你可以直接将选项传递给脚本

  $ ./bin/docs --no-frames --include-log

• 或者你可以使用docs部分的defaults条目

  [docs]
  recipe = z3c.recipe.epydoc
  eggs =
  z3c.recipe.epydoc
  ezineserver
  doc = ezineserver
  defaults = ['no-frames', '--include-log']

这允许你创建一个具有与在命令行中指定相同的选项的脚本。

如果未设置，则 默认值 条目将默认为值 ['-v', '--debug']。

0.0.3 (2009-03-10)

• 在 buildout.cfg 中添加默认 CLI 参数选项 - 感谢 Jonathan Ballet

0.0.2 (2008-07-09)

• 将 sys.argv 传递给 bin/docs（你可以在脚本中传递额外的 epydoc 选项）

0.0.1 (2008-07-08)

• 初始版本。