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

Project Configuration This class loads the configuration and settings for a project. More...

Inheritance diagram for ProjectConfig:
ConfigCore object

Public Member Functions

def __init__ (self, proj, dic)
 Load project configuration. More...
 

Public Attributes

 abbrev
 Abbreviation. More...
 
 branch
 The git branch (defaults to master_. More...
 
 build_dir
 
 checkout
 The checkout url. More...
 
 color
 Project color - This is output in the index. More...
 
 copy
 Files to copy. More...
 
 date_updated
 Date of last build. More...
 
 doxy_args
 Extra doxy args. More...
 
 doxy_file
 The doxy file to use if present A project might not have a doxy file. More...
 
 is_git
 True is repo: is git. More...
 
 is_main
 Whether this is the main/self config This affect mainly to build target which is not a subdirectory. More...
 
 is_svn
 True if repo: is svn. More...
 
 json_info_path
 The full path to the json encoded info file config.ConfigCore.INFO_JSON_FILE. More...
 
 official
 Whether this is an official upstream repository. More...
 
 proj
 The project key. More...
 
 project_page
 
 repo
 The repo type. More...
 
 runlevel
 The runlevel. More...
 
 tags
 The tag files to include. More...
 
 temp_doxy_path
 The full path to the temp doxy file. More...
 
 title
 Project Title. More...
 
 version
 Placeholde Version. More...
 
 version_file
 The version file. More...
 
 version_no
 The version No. More...
 
 work_dir
 

Static Public Attributes

string BUILD = "/home/fg/api-docs.freeflightsim.org/"
 Location of the build/ output directory WITH TRAILING /. More...
 
string CONFIG_FILE = "projects.config.yaml"
 Name of the config file. More...
 
string DEFAULT_DOXY = "doxy-default.conf"
 Name of the default doxygen file. More...
 
string ETC = ROOT+"etc/"
 Location of etc/ dir with trailing /. More...
 
string INFO_JSON_FILE = "info.json"
 Name of the json encoded. More...
 
tuple ROOT = os.path.abspath( os.path.dirname(__file__) + "/../" )
 Absolute directory path to location of this file with trailing /. More...
 
string SELF_PROJ = "fgdocx"
 This project itself. More...
 
string TEMP = ROOT+"temp/"
 Location of the temp/ directory with trailing /. More...
 
string TEMP_DOXY = "fg_docs_temp_doxy.conf"
 

Detailed Description

Project Configuration This class loads the configuration and settings for a project.

Definition at line 48 of file config.py.

Constructor & Destructor Documentation

def __init__ (   self,
  proj,
  dic 
)

Load project configuration.

Parameters
projThe project key
dicThe project dictionary

Definition at line 53 of file config.py.

Member Data Documentation

abbrev

Abbreviation.

Definition at line 63 of file config.py.

branch

The git branch (defaults to master_.

See also
branch:

Definition at line 97 of file config.py.

string BUILD = "/home/fg/api-docs.freeflightsim.org/"
staticinherited

Location of the build/ output directory WITH TRAILING /.

Definition at line 32 of file config.py.

build_dir

Definition at line 102 of file config.py.

checkout

The checkout url.

See also
checkout:

Definition at line 87 of file config.py.

color

Project color - This is output in the index.

See also
color:

Definition at line 72 of file config.py.

string CONFIG_FILE = "projects.config.yaml"
staticinherited

Name of the config file.

Definition at line 41 of file config.py.

copy

Files to copy.

Definition at line 110 of file config.py.

date_updated

Date of last build.

Definition at line 137 of file config.py.

string DEFAULT_DOXY = "doxy-default.conf"
staticinherited

Name of the default doxygen file.

Definition at line 35 of file config.py.

doxy_args

Extra doxy args.

See also
doxy_args:

Definition at line 118 of file config.py.

doxy_file

The doxy file to use if present A project might not have a doxy file.

Definition at line 129 of file config.py.

string ETC = ROOT+"etc/"
staticinherited

Location of etc/ dir with trailing /.

Definition at line 26 of file config.py.

string INFO_JSON_FILE = "info.json"
staticinherited

Name of the json encoded.

Definition at line 38 of file config.py.

is_git

True is repo: is git.

Definition at line 90 of file config.py.

is_main

Whether this is the main/self config This affect mainly to build target which is not a subdirectory.

Definition at line 60 of file config.py.

is_svn

True if repo: is svn.

Definition at line 93 of file config.py.

json_info_path

The full path to the json encoded info file config.ConfigCore.INFO_JSON_FILE.

Definition at line 158 of file config.py.

official

Whether this is an official upstream repository.

Definition at line 134 of file config.py.

proj

The project key.

Definition at line 56 of file config.py.

project_page

Definition at line 83 of file config.py.

repo

The repo type.

See also
repo:

Definition at line 80 of file config.py.

tuple ROOT = os.path.abspath( os.path.dirname(__file__) + "/../" )
staticinherited

Absolute directory path to location of this file with trailing /.

Definition at line 23 of file config.py.

runlevel

The runlevel.

See also
runlevel:

Definition at line 76 of file config.py.

string SELF_PROJ = "fgdocx"
staticinherited

This project itself.

Definition at line 20 of file config.py.

tags

The tag files to include.

See also
Tags Config

Definition at line 164 of file config.py.

string TEMP = ROOT+"temp/"
staticinherited

Location of the temp/ directory with trailing /.

Definition at line 29 of file config.py.

string TEMP_DOXY = "fg_docs_temp_doxy.conf"
staticinherited

Definition at line 43 of file config.py.

temp_doxy_path

The full path to the temp doxy file.

Definition at line 155 of file config.py.

title

Project Title.

See also
title:

Definition at line 68 of file config.py.

version

Placeholde Version.

populated by:

Definition at line 152 of file config.py.

version_file

The version file.

See also
Version Config:

Definition at line 147 of file config.py.

version_no

The version No.

See also
Version Config:

Definition at line 141 of file config.py.

work_dir

Definition at line 106 of file config.py.


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