********************
API Reference Manual
********************

The Param API Reference Manual provides a comprehensive reference for
all modules, functions, classes, and methods provided by Param. See the
`User Guide <../user_guide>`_ for a more readable overview and explanations;
this material duplicates what is available from `help(obj)` for each object.

`parameterized`_
 Parameter, Parameterized, and other core classes and methods
`param`_
 Optional predefined parameter types like Number, Selector, etc.
`ipython`_
 Optional help functions tailored for Jupyter and IPython
`serializer`_
 Optional JSON serialization
`version`_
 Automatic generation of version strings using version control


parameterized Module
====================

.. inheritance-diagram:: param.parameterized

---------------------------

.. automodule:: param.parameterized
    :members:
    :inherited-members:
    :show-inheritance:


param Module
===============

.. inheritance-diagram:: param.__init__

----------------------

.. automodule:: param.__init__
    :members:
    :inherited-members:
    :show-inheritance:


ipython Module
==============

.. inheritance-diagram:: param.ipython

---------------------

.. automodule:: param.ipython
    :members:
    :inherited-members:
    :show-inheritance:


serializer Module
=================

.. inheritance-diagram:: param.serializer

------------------------

.. automodule:: param.serializer
    :members:
    :inherited-members:
    :show-inheritance:


version Module
==============

.. inheritance-diagram:: param.version

---------------------

.. automodule:: param.version
    :members:
    :inherited-members:
    :show-inheritance:


.. _parameterized: #parameterized-module
.. _param: #param-module
.. _ipython: #ipython-module
.. _serializer: #serializer-module
.. _version: #version-module
       
