API Reference
=============

Date objects
------------

.. autoclass:: khayyam.JalaliDate
    :members:
    :special-members:

.. Commented
    :private-members:
    :show-inheritance:
    :undoc-members:
    :special-members:
    :exclude-members: __dict__

Date & Time objects
-------------------

.. autoclass:: khayyam.JalaliDatetime
    :members:
    :special-members:

Formatting & Parsing
--------------------

.. autoclass:: khayyam.formatting.BaseFormatter
    :members:
    :show-inheritance:

.. autoclass:: khayyam.formatting.JalaliDateFormatter
    :members:
    :show-inheritance:

.. autoclass:: khayyam.formatting.JalaliDatetimeFormatter
    :members:
    :show-inheritance:

Directives
^^^^^^^^^^

.. automodule:: khayyam.formatting.directives.base
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.ampm
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.day
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.month
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.persian
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.time
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.tz
    :members:
    :show-inheritance:
    :special-members:

.. automodule:: khayyam.formatting.directives.year
    :members:
    :show-inheritance:
    :special-members:


Timezone objects
----------------

.. autoclass:: khayyam.Timezone
    :members:
    :show-inheritance:

.. autoclass:: khayyam.TehranTimezone
    :members:
    :show-inheritance:

Constants
---------

.. automodule:: khayyam.constants
    :members:
    :undoc-members:
    :show-inheritance: