.. soup_schema documentation master file, created by
   sphinx-quickstart on Sat Sep 10 08:49:41 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 4

.. include:: ../README.rst

API documentation
-----------------

soup_schema
***********

All submodule classes are exposed and importable directly from ``soup_schema``.

- ``soup_schema.Schema`` - :class:`soup_schema.schema.Schema`
- ``soup_schema.Selector`` - :class:`soup_schema.selector.Selector`
- ``soup_schema.AnySelector`` - :class:`soup_schema.selector.AnySelector`
- ``soup_schema.AttrSelector`` - :class:`soup_schema.selector.AttrSelector`
- ``soup_schema.SchemaSelector`` - :class:`soup_schema.selector.SchemaSelector`
- ``soup_schema.ValidationError`` - :class:`soup_schema.error.ValidationError`


Schema
~~~~~~

.. automodule:: soup_schema.schema
    :members:
    :undoc-members:
    :show-inheritance:

Selector
~~~~~~~~

.. automodule:: soup_schema.selector
    :members:
    :undoc-members:
    :show-inheritance:

Error
~~~~~

.. automodule:: soup_schema.error
    :members:
    :undoc-members:
    :show-inheritance:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`