nmk_doc.builders
================

.. py:module:: nmk_doc.builders

.. autoapi-nested-parse::

   Python module for **nmk-doc** plugin builders.



Classes
-------

.. autoapisummary::

   nmk_doc.builders.NmkDocSphinxBuilder
   nmk_doc.builders.PlantUmlBuilder
   nmk_doc.builders.SnippetsBuilder


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

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

   Bases: :py:obj:`nmk.model.builder.NmkTaskBuilder`


   Builder used to trigger **sphinx** documentation build


   .. py:method:: build(source_folder: str, output_folder: str, version: str = '')

      Called by the **doc.build** task, to build the **sphinx** documentation

      :param source_folder: doc source folder
      :param output_folder: doc output folder
      :param version: project version



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

   Bases: :py:obj:`nmk.model.builder.NmkTaskBuilder`


   Builder used to trigger **plantuml** diagram generation


   .. py:method:: build(jar: str, java_runtime: str, input_folder: str, output_folder: str, formats: list[str], extra_options: str)

      Called by the **puml.generate** task, to generate diagrams

      :param jar: path to the PlantUML JAR file
      :param java_runtime: path to the Java runtime
      :param input_folder: input folder containing the diagram source files
      :param output_folder: output folder for the generated diagrams
      :param formats: list of output formats
      :param extra_options: extra options for the PlantUML command



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

   Bases: :py:obj:`nmk.model.builder.NmkTaskBuilder`


   Builder used to generate documentation snippets


   .. py:method:: build(snippets: dict[str, str], output_folder: str)

      Called by the **doc.snippets** task, to generate documentation snippets

      :param snippets: dict of snippet name to command to execute
      :param output_folder: output folder for the generated snippets