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的可执行脚本。

此脚本将在 源代码。

要生成文档，只需运行docsscript:

$ ./bin/docs

这将为您生成所有文档并将其放在 零件目录。然后您可以在Firefox中打开它并查看：

$ firefox parts/docs/index.html

就这样！

指定其他选项

还可以将其他epydoc选项传递给docs脚本（用于 所有可用选项的列表，使用--help选项运行脚本。

您可以通过两种不同的方式来完成此操作：

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

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

• 或者您可以使用defaults条目到docs部分：

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

这允许您创建具有相同选项的脚本 在命令行中指定它们。

如果未设置，defaults项将默认为值['-v','--debug']。

0.0.3（2009-03-10）

• 在buildout.cfg中添加默认的cli arguments选项-感谢jonathan ballet

0.0.2（2008-07-09）

• 将sys.argv传递到bin/docs（您可以传递其他epydoc选项do script）

0.0.1（2008-07-08）

• 初次发布。