Package turbogears :: Module docgen :: Class GenSite

Class GenSite

source code

setuptools command to generate the TurboGears website

Instance Methods

[hide private]

initialize_options(self)
Set default values for all the options that this command supports.

source code

finalize_options(self)
Set final values for all the options that this command supports.

source code

_split_mapping(self, valToSplit, preserve_order=False)

source code

check_if_newer(self, src, dest)

source code

copy_if_newer(self, src, dest)

source code

render_template(self, src, dest, depth)

source code

update_site_files(self, srcdir, processTemplates=True, destroot=None)

source code

delete_excess_files(self)

source code

run(self)
A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'.

source code

printable_tutorial(self)

source code

_make_printable(self, tutdir, up_to_root=2)

source code

Inherited from setuptools.Command: __init__, reinitialize_command

Inherited from distutils.cmd.Command: __getattr__, announce, copy_file, copy_tree, debug_print, dump_options, ensure_dirname, ensure_filename, ensure_finalized, ensure_string, ensure_string_list, execute, get_command_name, get_finalized_command, get_sub_commands, make_archive, make_file, mkpath, move_file, run_command, set_undefined_options, spawn, warn

Inherited from distutils.cmd.Command (private): _ensure_stringlike, _ensure_tested_string

Class Variables

[hide private]

user_options = [('srcdirs=', 's', 'directories containing the ...

boolean_options = ['force']

srcdirs = None

destdir = 'dist/site'

encoding = 'utf8'

force = False

ignoredirs = None

ignorefiles = None

nodelete = None

templates = None

copydirs = None

eggdir = '../thirdparty/eggs'

noprintable = False

Inherited from setuptools.Command: __doc__, command_consumes_arguments

Inherited from distutils.cmd.Command: sub_commands

Method Details

[hide private]

initialize_options(self)

source code

Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, 'initialize_options()' implementations are just a bunch of "self.foo = None" assignments.

This method must be implemented by all command classes.

Overrides: distutils.cmd.Command.initialize_options: (inherited documentation)

finalize_options(self)

source code

Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if 'foo' depends on 'bar', then it is safe to set 'foo' from 'bar' as long as 'foo' still has the same value it was assigned in 'initialize_options()'.

This method must be implemented by all command classes.

Overrides: distutils.cmd.Command.finalize_options: (inherited documentation)

run(self)

source code

A command's raison d'etre: carry out the action it exists to perform, controlled by the options initialized in 'initialize_options()', customized by other commands, the setup script, the command-line, and config files, and finalized in 'finalize_options()'. All terminal output and filesystem interaction should be done by 'run()'.

This method must be implemented by all command classes.

Overrides: distutils.cmd.Command.run: (inherited documentation)

Class Variable Details

[hide private]

user_options

Value:

[('srcdirs=',
  's',
  'directories containing the source files (default: docs)'),
 ('destdir=',
  'd',
  'destination output directory (default: dist/site)'),
 ('encoding=', 'e', 'encoding for output (default: utf8)'),
 ('force', 'f', 'regenerate all files'),
...