Files
deb-python-wsme/doc/api.rst
Christophe de Vienne 22f9ea3d67 Documented most of the api
2011-10-11 16:15:13 +02:00

40 lines
655 B
ReStructuredText

API
===
Public API
----------
:mod:`wsme` -- Essentials
~~~~~~~~~~~~~~~~~~~~~~~~~
.. module:: wsme
.. autoclass:: wsme.expose
.. autoclass:: wsme.validate
.. autoclass:: wsme.wsproperty
.. autoclass:: wsme.wsattr
Internals
---------
:mod:`wsme.types` -- Types
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.types
:members: register_type
:mod:`wsme.controller` -- Controller
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.controller
:members: scan_api, FunctionArgument, FunctionDefinition, WSRoot
:mod:`wsme.rest` -- REST protocol commons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: wsme.rest
:members: