From f4cb6fb87749491bce5e3e6b2d7bfafdf7764435 Mon Sep 17 00:00:00 2001 From: INADA Naoki Date: Sun, 24 Feb 2013 18:06:36 +0900 Subject: Add apidoc --- docs/api.rst | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/api.rst (limited to 'docs/api.rst') 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: + -- cgit v1.2.1 From 230537cf287e5b6985f1fd06ebb01a45776065e6 Mon Sep 17 00:00:00 2001 From: INADA Naoki Date: Mon, 25 Feb 2013 14:29:49 +0900 Subject: Update docs. --- docs/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/api.rst') diff --git a/docs/api.rst b/docs/api.rst index a26e7c7..7efc04a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,5 @@ API reference -=============== +============= .. module:: msgpack -- cgit v1.2.1 From 3ce005cf377eaeb5a517ce82698e4ae4381e67b9 Mon Sep 17 00:00:00 2001 From: INADA Naoki Date: Tue, 26 Feb 2013 09:20:44 +0900 Subject: better packer docstring --- docs/api.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/api.rst') diff --git a/docs/api.rst b/docs/api.rst index 7efc04a..ccc7952 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -36,3 +36,8 @@ These exceptions are accessible via `msgpack` package. :undoc-members: :show-inheritance: +.. automodule:: msgpack.fallback + :members: + :undoc-members: + :show-inheritance: + -- cgit v1.2.1 From d2feb1362946c87609e3753a058ddbd0958ee0bd Mon Sep 17 00:00:00 2001 From: INADA Naoki Date: Tue, 26 Feb 2013 14:20:44 +0900 Subject: doc: remove fallback from api reference. --- docs/api.rst | 6 ------ 1 file changed, 6 deletions(-) (limited to 'docs/api.rst') diff --git a/docs/api.rst b/docs/api.rst index ccc7952..50a84c4 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -35,9 +35,3 @@ These exceptions are accessible via `msgpack` package. :members: :undoc-members: :show-inheritance: - -.. automodule:: msgpack.fallback - :members: - :undoc-members: - :show-inheritance: - -- cgit v1.2.1