===================
``origen.compiler``
===================

.. automodule:: origen.compiler

   .. contents::
      :local:

.. currentmodule:: origen.compiler


Classes
=======

- :py:class:`Compiler`:
  Undocumented.

- :py:class:`JinjaRenderer`:
  Helper class that provides a standard way to create an ABC using

- :py:class:`MakoRenderer`:
  Helper class that provides a standard way to create an ABC using

- :py:class:`Renderer`:
  Helper class that provides a standard way to create an ABC using


.. autoclass:: Compiler
   :members:
   :undoc-members:
   :inherited-members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Compiler
      :parts: 1
.. autoclass:: JinjaRenderer
   :members:
   :undoc-members:
   :inherited-members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: JinjaRenderer
      :parts: 1
.. autoclass:: MakoRenderer
   :members:
   :undoc-members:
   :inherited-members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MakoRenderer
      :parts: 1
.. autoclass:: Renderer
   :members:
   :undoc-members:
   :inherited-members:

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

Exceptions
==========

- :py:exc:`ExplicitSyntaxRequiredError`:
  Raised when an explicit syntax is required, but none was given 

- :py:exc:`UnknownSyntaxError`:
  Raised when an unknown syntax if given 


.. autoexception:: ExplicitSyntaxRequiredError

.. rubric:: Inheritance
   .. inheritance-diagram:: ExplicitSyntaxRequiredError
      :parts: 1
.. autoexception:: UnknownSyntaxError

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