nmk_doc.resolvers
=================

.. py:module:: nmk_doc.resolvers

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   nmk_doc.resolvers.NmkDocYearResolver
   nmk_doc.resolvers.PlantUmlOutputFilesResolver
   nmk_doc.resolvers.DiagramsReadyResolver


Module Contents
---------------

.. py:class:: NmkDocYearResolver(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkIntConfigResolver`


   Current year resolver


   .. py:method:: get_value(name: str) -> int

      Get today's year.

      :param name: config item name to be resolved
      :return: current year



.. py:class:: PlantUmlOutputFilesResolver(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkListConfigResolver`


   Resolver for the list of generated PlantUML image files


   .. py:method:: get_value(name: str, diagrams: list[str], output_folder: str, formats: list[str]) -> list[str]

      Get the list of generated PlantUML image files.

      :param name: config item name to be resolved
      :param diagrams: list of diagram source files
      :param output_folder: output folder for the generated diagrams
      :param formats: list of output formats
      :return: list of generated image files



.. py:class:: DiagramsReadyResolver(model: nmk.model.model.NmkModel)

   Bases: :py:obj:`nmk.model.resolver.NmkBoolConfigResolver`


   Resolver to check if diagrams are ready to be generated


   .. py:method:: get_value(name: str, diagrams: list[str], java_runtime: str) -> bool

      Check if diagrams are ready to be generated.

      :param name: config item name to be resolved
      :param diagrams: list of diagram source files
      :param java_runtime: path to the Java runtime
      :return: True if all diagrams are ready to be generated, False otherwise