======================
``plantweb.directive``
======================

.. automodule:: plantweb.directive

   .. contents::
      :local:

.. currentmodule:: plantweb.directive


Functions
=========

- :py:func:`setup`:
  Setup function that makes this module a Sphinx extension.

- :py:func:`builder_inited_handler`:
  We use this event handler to grab user defaults for Plantweb and use them

- :py:func:`defaults_provider`:
  Defaults provider that allows to register Sphinx user defaults.


.. autofunction:: setup

.. autofunction:: builder_inited_handler

.. autofunction:: defaults_provider


Classes
=======

- :py:class:`Plantweb`:
  FIXME: Document.

- :py:class:`UmlDirective`:
  Specialized ``uml`` directive for Plantweb ``Plantweb`` engine.

- :py:class:`GraphDirective`:
  Specialized ``graph`` directive for Plantweb ``graphviz`` engine.

- :py:class:`DiagramDirective`:
  Specialized ``diagram`` directive for Plantweb ``ditaa`` engine.


.. autoclass:: Plantweb
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Plantweb
      :parts: 1

.. autoclass:: UmlDirective
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: UmlDirective
      :parts: 1

.. autoclass:: GraphDirective
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: GraphDirective
      :parts: 1

.. autoclass:: DiagramDirective
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: DiagramDirective
      :parts: 1