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

.. py:module:: nmk_doc.builders

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   nmk_doc.builders.NmkDocSphinxBuilder


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)

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

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