pyb.tasks.py

Package pyb :: Package tasks :: Module py

[show private | hide private]

Module pyb.tasks.py

Python related tasks.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Function Summary
	`epydoc(app, format, destdir, modules, url, top, css, private, privateCss, inheritance)` Generate documentation using Epydoc.
	`python(script, args)` Execute the specified script using Python.
	`setup(file, commands)` Execute distutils.setup command

Function Details

epydoc(app=None, format='html', destdir=None, modules=None, url=None, top=None, css=None, private=False, privateCss=None, inheritance=None)

Generate documentation using Epydoc.

Parameters:: app - The path to epydoc; format - Specify the display format (either 'html' or 'javadoc'); destdir - The destination directory (REQUIRED); modules - List of modules to document; url - The documented project's URL; top -; css - The CSS stylesheet for the docs; private - Set to True to display private items; inheritance -

python(script=None, args=[])

Execute the specified script using Python.

Note that this task executes Python in a new process.

Parameters:: script - The Python script to execute; args - Command-line arguments passed to the script

Returns:: A tuple with the stdout and stderr file objects

setup(file=None, commands=None)

Execute distutils.setup command

Parameters:: file - The setup.py file path; commands - A List of commands (sdist, bdist, etc.)

Generated by Epydoc 2.1 on Fri Apr 23 15:39:19 2004

http://epydoc.sf.net