.. _api_ref:

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

Welcome to the API reference for ``predctiably``.

The API reference provides a technical manual, describing the class and
function interface provided by the package. See the :ref:`user_guide` for
additional details.

.. automodule:: predictably
    :no-members:
    :no-inherited-members:

Configure ``predictably``
=========================

.. automodule:: predictably
    :no-members:
    :no-inherited-members:

.. currentmodule:: predictably

.. autosummary::
    :toctree: api_reference/auto_generated/
    :template: function.rst

    get_config
    get_default_config
    set_config
    reset_config
    config_context

.. _obj_validation:

Object Validation and Comparison
================================

.. currentmodule:: predictably.validate

.. autosummary::
    :toctree: api_reference/auto_generated/
    :template: function.rst

    check_sequence
    check_sequence_named_objects
    check_type
    is_sequence
    is_sequence_named_objects

Utils
=====

.. automodule:: predictably.utils
    :no-members:
    :no-inherited-members:

.. currentmodule:: predictably.utils

.. autosummary::
    :toctree: api_reference/auto_generated/
    :template: function.rst