[ MODULE ] - Package info module. More...

Variables
string	NAME = 'sStashPackageDocumentation'
	[ str ] - Name of the package. More...

string	VERSION = '1.0.0'
	[ str ] - Version of the package. More...

string	DESCRIPTION = 'Doxygen documentation of all Stash packages.'
	[ str ] - Description about the package. More...

list	KEYWORDS = ['doxygen', 'documentation', 'help']
	[ list of str ] - Keywords to find this package. More...

list	PLATFORMS = ['Linux', 'Darwin', 'Windows']
	[ list of str ] - Platforms which this package meant to be used on. More...

list	DOCUMENTS
	[ list of dict ] - Documentations about the package, keys of dict instances are: title, url. More...

list	APPLICATIONS = ['all']
	[ list of str ] - Applications which this package meant to be initialized for. More...

list	PYTHON_VERSIONS = ['2', '2.7.5', '2.7.10', '3']
	[ list of str ] - Python versions supported by this package. More...

bool	IS_ACTIVE = True
	[ bool ] - Whether this package is active (in use). More...

bool	IS_EXTERNAL = False
	[ bool ] - Whether this package is external (third party). More...

list	DEVELOPERS = ['developer@stashsoftware.com']
	[ list of str ] - E-mail addresses of the developers. More...

list	DEPENDENT_PACKAGES = []
	[ list of str ] - Dependent packages. More...

Detailed Description

[ MODULE ] - Package info module.

Variable Documentation

◆ NAME

string sStashPackageDocumentation.packageInfoLib.NAME = 'sStashPackageDocumentation'

[ str ] - Name of the package.

◆ VERSION

string sStashPackageDocumentation.packageInfoLib.VERSION = '1.0.0'

[ str ] - Version of the package.

◆ DESCRIPTION

string sStashPackageDocumentation.packageInfoLib.DESCRIPTION = 'Doxygen documentation of all Stash packages.'

[ str ] - Description about the package.

◆ KEYWORDS

list sStashPackageDocumentation.packageInfoLib.KEYWORDS = ['doxygen', 'documentation', 'help']

[ list of str ] - Keywords to find this package.

◆ PLATFORMS

list sStashPackageDocumentation.packageInfoLib.PLATFORMS = ['Linux', 'Darwin', 'Windows']

[ list of str ] - Platforms which this package meant to be used on.

◆ DOCUMENTS

list sStashPackageDocumentation.packageInfoLib.DOCUMENTS

Initial value:

 =  [{'title':'Commands',
                         'url':'https://charmapps.atlassian.net/wiki/spaces/StashSoftware/pages/657195144/sStashPackageDocumentation+-+Commands'},
                        {'title':'Python API',
                         'url':'https://charmapps.atlassian.net/wiki/spaces/StashSoftware/pages/657195244/sStashPackageDocumentation+-+Python+API'}
                        ]

[ list of dict ] - Documentations about the package, keys of dict instances are: title, url.

◆ APPLICATIONS

list sStashPackageDocumentation.packageInfoLib.APPLICATIONS = ['all']

[ list of str ] - Applications which this package meant to be initialized for.

◆ PYTHON_VERSIONS

list sStashPackageDocumentation.packageInfoLib.PYTHON_VERSIONS = ['2', '2.7.5', '2.7.10', '3']

[ list of str ] - Python versions supported by this package.

◆ IS_ACTIVE

bool sStashPackageDocumentation.packageInfoLib.IS_ACTIVE = True

[ bool ] - Whether this package is active (in use).

◆ IS_EXTERNAL

bool sStashPackageDocumentation.packageInfoLib.IS_EXTERNAL = False

[ bool ] - Whether this package is external (third party).

◆ DEVELOPERS

list sStashPackageDocumentation.packageInfoLib.DEVELOPERS = ['developer@stashsoftware.com']

[ list of str ] - E-mail addresses of the developers.

◆ DEPENDENT_PACKAGES

list sStashPackageDocumentation.packageInfoLib.DEPENDENT_PACKAGES = []

[ list of str ] - Dependent packages.

Variables