nmk_doc.resolvers

Module containing all config item resolvers for nmk-doc plugin.

Module Contents

Classes

NmkDocInputsResolver	Resolves all files in doc folder
NmkDocVersionResolver	Documentation version resolver
NmkDocYearResolver	Current year resolver

Attributes

DOC_INCREMENT_PATTERN

Document version increment verification pattern

nmk_doc.resolvers.DOC_INCREMENT_PATTERN

Document version increment verification pattern

class nmk_doc.resolvers.NmkDocInputsResolver(model: nmk.model.model.NmkModel)

Bases: nmk_base.resolvers.FilesResolver

Resolves all files in doc folder

property folder_config: str

Tells FilesResolver to search files in ${docPath} config item.

class nmk_doc.resolvers.NmkDocVersionResolver(model: nmk.model.model.NmkModel)

Bases: nmk.model.resolver.NmkStrConfigResolver

Documentation version resolver

get_value(name: str) → str

Get resolved version value. Behavior of the version resolution is:

• take git version (see ${gitVersion} config item description)

• if this is a tagged version, simply use it

• otherwise deduce last tag and increment it with increment configured in ${docVersionIncrement} config item

Parameters:

name – config item name to be resolved

Returns:

resolved version

class nmk_doc.resolvers.NmkDocYearResolver(model: nmk.model.model.NmkModel)

Bases: nmk.model.resolver.NmkIntConfigResolver

Current year resolver

get_value(name: str) → int

Get today’s year.

Parameters:

name – config item name to be resolved

Returns:

current year