Package zope :: Package configuration :: Module stxdocs
[show private | hide private]
[frames | no frames]

Module zope.configuration.stxdocs

STX Configuration Documentation Renderer

Usage: stxdocs.py [options]
Options:
    -h / --help
        Print this message and exit.

    -f <path>
        Specifies the root ZCML meta directives file, relative to the current
        location. All included files will be considered as well

    -o <dir>
        Specifies a directory, relative to the current location in which the
        documentation is stored. Note that this tool will create
        sub-directories with files in them. 

$Id: stxdocs.py,v 1.2 2005/06/24 16:52:27 nyergler Exp $

Function Summary
  main(argv)
  makedocs(target_dir, zcml_file)
Generate the documentation tree.
  usage(code, msg)

Function Details

makedocs(target_dir, zcml_file)

Generate the documentation tree.

All we need for this is a starting ZCML file and a directory in which to put the documentation.

Generated by Epydoc 2.1 on Fri Jun 24 12:01:24 2005 http://epydoc.sf.net