diff options
author | INADA Naoki <inada-n@klab.com> | 2013-02-24 18:06:36 +0900 |
---|---|---|
committer | INADA Naoki <inada-n@klab.com> | 2013-02-24 18:06:36 +0900 |
commit | f4cb6fb87749491bce5e3e6b2d7bfafdf7764435 (patch) | |
tree | b4522eacab9dcf117af630f94a5dece801b5ef54 /docs/api.rst | |
parent | 04e0812ad409d3aa2d18f3f3de02812164a83fea (diff) | |
download | msgpack-python-f4cb6fb87749491bce5e3e6b2d7bfafdf7764435.tar.gz |
Add apidoc
Diffstat (limited to 'docs/api.rst')
-rw-r--r-- | docs/api.rst | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..a26e7c7 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,38 @@ +API reference +=============== + +.. module:: msgpack + +.. autofunction:: pack + +:func:`dump` is alias for :func:`pack` + +.. autofunction:: packb + +:func:`dumps` is alias for :func:`packb` + +.. autofunction:: unpack + +:func:`load` is alias for :func:`unpack` + +.. autofunction:: unpackb + +:func:`loads` is alias for :func:`unpackb` + +.. autoclass:: Packer + :members: + +.. autoclass:: Unpacker + :members: + +exceptions +----------- + +These exceptions are accessible via `msgpack` package. +(For example, `msgpack.OutOfData` is shortcut for `msgpack.exceptions.OutOfData`) + +.. automodule:: msgpack.exceptions + :members: + :undoc-members: + :show-inheritance: + |