nmk_doc.resolvers

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

Classes

NmkDocYearResolver	Current year resolver
PlantUmlOutputFilesResolver	Resolver for the list of generated PlantUML image files
DiagramsReadyResolver	Resolver to check if diagrams are ready to be generated
DocSnippetsOutputFilesResolver	Resolver for the list of generated documentation snippet files

Module Contents

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

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

Bases: nmk.model.resolver.NmkListConfigResolver

Resolver for the list of generated PlantUML image files

get_value(name: str, diagrams: list[str], output_folder: str, formats: list[str]) → list[str]

Get the list of generated PlantUML image files.

Parameters:

• name – config item name to be resolved

• diagrams – list of diagram source files

• output_folder – output folder for the generated diagrams

• formats – list of output formats

Returns:

list of generated image files

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

Bases: nmk.model.resolver.NmkBoolConfigResolver

Resolver to check if diagrams are ready to be generated

get_value(name: str, diagrams: list[str], java_runtime: str) → bool

Check if diagrams are ready to be generated.

Parameters:

• name – config item name to be resolved

• diagrams – list of diagram source files

• java_runtime – path to the Java runtime

Returns:

True if all diagrams are ready to be generated, False otherwise

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

Bases: nmk.model.resolver.NmkListConfigResolver

Resolver for the list of generated documentation snippet files

get_value(name: str, snippets: dict[str, str], output_folder: str) → list[str]

Get the list of generated documentation snippet files.

Parameters:

• name – config item name to be resolved

• snippets – map of snippets definition, indexed by output file names

• output_folder – output folder for the generated snippets

Returns:

list of generated snippet files