fgdocx  0.2 [master]
FlightGear API Docs
Public Member Functions | Public Attributes | List of all members
ProjectBuilder Class Reference

Builds a project. More...

Public Member Functions

def __init__
 Initialze the project builder from configs. More...
 
def copy_files (self)
 Copies the files and paths in copy:. More...
 
def get_branch (self)
 
def get_build_cmd (self)
 
def get_doxy_args (self)
 
def get_doxy_file (self)
 Return the contents of the doxy file. More...
 
def get_navigation (self)
 Top navigation list. More...
 
def get_projects_pages_cpp (self)
 
def get_projects_table_html (self)
 Return the html index page. More...
 
def get_repo_link (self)
 
def get_version (self)
 
def post_build (self)
 
def prepare (self)
 Prepare the project, copying files, setting up doxy etc. More...
 
def wd (self)
 
def write_header_html (self)
 Writes out the html header file. More...
 
def write_info_file (self)
 Write out json encoded info file to config.Config.INFO_JSON_FILE. More...
 
def write_temp_doxy (self, contents)
 Write out temp doxy file. More...
 

Public Attributes

 conf
 ProjectConfig object. More...
 
 main_conf
 Config object. More...
 
 projname
 
 V
 Verbosity 0-4. More...
 
 version
 =========================================== More...
 

Detailed Description

Builds a project.

Definition at line 14 of file project.py.

Constructor & Destructor Documentation

def __init__ (   self,
  mainConf,
  projname,
  verbose = 1 
)

Initialze the project builder from configs.

Parameters
mainConf- a config.Config instance
projObj- a config.ProjectConfig instance
verbose- verbosity of output

Definition at line 20 of file project.py.

Member Function Documentation

def copy_files (   self)

Copies the files and paths in copy:.

Definition at line 181 of file project.py.

Referenced by ProjectBuilder.prepare().

def get_branch (   self)

Definition at line 222 of file project.py.

Referenced by ProjectBuilder.write_header_html().

def get_build_cmd (   self)

Definition at line 153 of file project.py.

def get_doxy_args (   self)

Definition at line 254 of file project.py.

Referenced by ProjectBuilder.prepare().

def get_doxy_file (   self)

Return the contents of the doxy file.

Definition at line 238 of file project.py.

Referenced by ProjectBuilder.prepare().

def get_navigation (   self)

Top navigation list.

Returns
str Hmtl nav list

Definition at line 203 of file project.py.

Referenced by ProjectBuilder.write_header_html().

def get_projects_pages_cpp (   self)

Definition at line 298 of file project.py.

Referenced by ProjectBuilder.prepare().

def get_projects_table_html (   self)

Return the html index page.

This is included in mainpage

Return values
strThe table contents

Definition at line 316 of file project.py.

Referenced by ProjectBuilder.prepare().

def get_repo_link (   self)

Definition at line 216 of file project.py.

Referenced by ProjectBuilder.write_header_html().

def get_version (   self)

Definition at line 268 of file project.py.

Referenced by ProjectBuilder.write_info_file().

def post_build (   self)

Definition at line 164 of file project.py.

def prepare (   self)

Prepare the project, copying files, setting up doxy etc.

Definition at line 38 of file project.py.

def wd (   self)

Definition at line 34 of file project.py.

def write_header_html (   self)

Writes out the html header file.

Definition at line 229 of file project.py.

Referenced by ProjectBuilder.prepare().

def write_info_file (   self)

Write out json encoded info file to config.Config.INFO_JSON_FILE.

Definition at line 289 of file project.py.

Referenced by ProjectBuilder.post_build().

def write_temp_doxy (   self,
  contents 
)

Write out temp doxy file.

Parameters
contentsThe doxy string

Definition at line 280 of file project.py.

Member Data Documentation

conf

ProjectConfig object.

Definition at line 32 of file project.py.

main_conf

Config object.

Definition at line 26 of file project.py.

projname

Definition at line 27 of file project.py.

V
version

===========================================

=========================================== Copy file @ see copy_config copy required file Create temp doxy string and write to file READ default Add the extra stuff doxy vars from config MAIN project extras Append and override the main settings from here get version no from yaml, or source file

Definition at line 115 of file project.py.


The documentation for this class was generated from the following file: