Package animio :: Module setup :: Class DocDistro

Class DocDistro

           object --+    
                    |    
            _GitMixin --+
                        |
distutils.cmd.Command --+
                        |
                       DocDistro

Build the documentation, and include everything into the git repository if required.

Instance Methods

[hide private]

__init__(self, *args)
Allows to configure some details, such as * remote name - name of the remote for which branches should be created/updated

source code

_doc_directory(self)
Returns: path to the doc directory which (usually) contains the makedoc executable

source code

_init_doc_generator(self)
initialize the docgen instance, and return it

source code

build_documentation(self)
Build the documentation with our current version tag - this allows it to be included in the release as it has been updated

source code

create_zip_archive(self, html_out_dir)
Create a zip archive from the data in the html output directory :return: path to the created zip file

source code

finalize_options(self)
Assure our args are of the correct type

source code

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

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

Inherited from _GitMixin: add_files_and_commit, branch_name, item_chooser, push_to_remotes, set_head_to, update_git

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

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, reinitialize_command, run_command, set_undefined_options, spawn, warn

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

Class Methods

[hide private]

Inherited from _GitMixin: adjust_user_options

Static Methods

[hide private]

Inherited from _GitMixin: __new__

Class Variables

[hide private]

branch_suffix = '-doc'

cmdname = 'docdist'

doc_dir = 'doc'

user_options = [('zip-archive', 'z', 'If set, a zip archive wi...

Inherited from _GitMixin: prev_head_name

Inherited from distutils.cmd.Command: sub_commands

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, args)
(Constructor)*

source code

Allows to configure some details, such as * remote name - name of the remote for which branches should be created/updated

Overrides: __init__: (inherited documentation)

_doc_directory(self)

source code

Returns:: path to the doc directory which (usually) contains the makedoc executable

build_documentation(self)

source code

Build the documentation with our current version tag - this allows it to be included in the release as it has been updated

Returns:: tuple(html_base, Bool) tuple with base directory containing all html files ( possibly with subdirectories ), and a boolean which is True if the documentation was build, False if it was still uptodate

finalize_options(self)

source code

Assure our args are of the correct type

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

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)

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:

[('zip-archive', 'z', 'If set, a zip archive will be created'),
 ('from-build-version',
  'b',
  'If set, the documentation will be built from the recent build_py or
 sdist version'),
 ('dist-remotes=',
  'd',
  'Default remotes to push the distribution branches to'),
...

Class DocDistro

__init__(self, *args) (Constructor)

_doc_directory(self)

build_documentation(self)

finalize_options(self)

initialize_options(self)

run(self)

user_options

init(self, args)
(Constructor)*