From 1a03fb0d4664445a1f4e91ed05ff1199028a0ca5 Mon Sep 17 00:00:00 2001 From: Fabian Schuh Date: Wed, 11 Jul 2018 14:11:48 +0200 Subject: [PATCH] Updated docs --- docs/grapheneapi.api.rst | 7 ++++++ docs/grapheneapi.exceptions.rst | 7 ++++++ docs/grapheneapi.grapheneapi.rst | 7 ++++++ docs/grapheneapi.grapheneclient.rst | 7 ++++++ docs/grapheneapi.graphenehttprpc.rst | 7 ++++++ docs/grapheneapi.graphenews.rst | 7 ++++++ docs/grapheneapi.graphenewsprotocol.rst | 7 ++++++ docs/grapheneapi.graphenewsrpc.rst | 7 ++++++ docs/grapheneapi.http.rst | 7 ++++++ docs/grapheneapi.rpc.rst | 7 ++++++ docs/grapheneapi.rst | 27 ++++++++++++++++++++++ docs/grapheneapi.websocket.rst | 7 ++++++ docs/graphenebase.account.rst | 7 ++++++ docs/graphenebase.base58.rst | 7 ++++++ docs/graphenebase.bip38.rst | 7 ++++++ docs/graphenebase.chains.rst | 7 ++++++ docs/graphenebase.dictionary.rst | 7 ++++++ docs/graphenebase.ecdsa.rst | 7 ++++++ docs/graphenebase.objects.rst | 7 ++++++ docs/graphenebase.objecttypes.rst | 7 ++++++ docs/graphenebase.operationids.rst | 7 ++++++ docs/graphenebase.operations.rst | 7 ++++++ docs/graphenebase.rst | 29 ++++++++++++++++++++++++ docs/graphenebase.signedtransactions.rst | 7 ++++++ docs/graphenebase.transactions.rst | 7 ++++++ docs/graphenebase.types.rst | 7 ++++++ docs/index.rst | 9 ++++++++ docs/modules.rst | 8 +++++++ 28 files changed, 241 insertions(+) create mode 100644 docs/grapheneapi.api.rst create mode 100644 docs/grapheneapi.exceptions.rst create mode 100644 docs/grapheneapi.grapheneapi.rst create mode 100644 docs/grapheneapi.grapheneclient.rst create mode 100644 docs/grapheneapi.graphenehttprpc.rst create mode 100644 docs/grapheneapi.graphenews.rst create mode 100644 docs/grapheneapi.graphenewsprotocol.rst create mode 100644 docs/grapheneapi.graphenewsrpc.rst create mode 100644 docs/grapheneapi.http.rst create mode 100644 docs/grapheneapi.rpc.rst create mode 100644 docs/grapheneapi.rst create mode 100644 docs/grapheneapi.websocket.rst create mode 100644 docs/graphenebase.account.rst create mode 100644 docs/graphenebase.base58.rst create mode 100644 docs/graphenebase.bip38.rst create mode 100644 docs/graphenebase.chains.rst create mode 100644 docs/graphenebase.dictionary.rst create mode 100644 docs/graphenebase.ecdsa.rst create mode 100644 docs/graphenebase.objects.rst create mode 100644 docs/graphenebase.objecttypes.rst create mode 100644 docs/graphenebase.operationids.rst create mode 100644 docs/graphenebase.operations.rst create mode 100644 docs/graphenebase.rst create mode 100644 docs/graphenebase.signedtransactions.rst create mode 100644 docs/graphenebase.transactions.rst create mode 100644 docs/graphenebase.types.rst create mode 100644 docs/modules.rst diff --git a/docs/grapheneapi.api.rst b/docs/grapheneapi.api.rst new file mode 100644 index 00000000..fcca21ed --- /dev/null +++ b/docs/grapheneapi.api.rst @@ -0,0 +1,7 @@ +grapheneapi\.api module +======================= + +.. automodule:: grapheneapi.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.exceptions.rst b/docs/grapheneapi.exceptions.rst new file mode 100644 index 00000000..f17e9e15 --- /dev/null +++ b/docs/grapheneapi.exceptions.rst @@ -0,0 +1,7 @@ +grapheneapi\.exceptions module +============================== + +.. automodule:: grapheneapi.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.grapheneapi.rst b/docs/grapheneapi.grapheneapi.rst new file mode 100644 index 00000000..83a4a6e5 --- /dev/null +++ b/docs/grapheneapi.grapheneapi.rst @@ -0,0 +1,7 @@ +grapheneapi\.grapheneapi module +=============================== + +.. automodule:: grapheneapi.grapheneapi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.grapheneclient.rst b/docs/grapheneapi.grapheneclient.rst new file mode 100644 index 00000000..429bcf16 --- /dev/null +++ b/docs/grapheneapi.grapheneclient.rst @@ -0,0 +1,7 @@ +grapheneapi\.grapheneclient module +================================== + +.. automodule:: grapheneapi.grapheneclient + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.graphenehttprpc.rst b/docs/grapheneapi.graphenehttprpc.rst new file mode 100644 index 00000000..bc3e7ea0 --- /dev/null +++ b/docs/grapheneapi.graphenehttprpc.rst @@ -0,0 +1,7 @@ +grapheneapi\.graphenehttprpc module +=================================== + +.. automodule:: grapheneapi.graphenehttprpc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.graphenews.rst b/docs/grapheneapi.graphenews.rst new file mode 100644 index 00000000..b3d5ac78 --- /dev/null +++ b/docs/grapheneapi.graphenews.rst @@ -0,0 +1,7 @@ +grapheneapi\.graphenews module +============================== + +.. automodule:: grapheneapi.graphenews + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.graphenewsprotocol.rst b/docs/grapheneapi.graphenewsprotocol.rst new file mode 100644 index 00000000..b6ef2a85 --- /dev/null +++ b/docs/grapheneapi.graphenewsprotocol.rst @@ -0,0 +1,7 @@ +grapheneapi\.graphenewsprotocol module +====================================== + +.. automodule:: grapheneapi.graphenewsprotocol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.graphenewsrpc.rst b/docs/grapheneapi.graphenewsrpc.rst new file mode 100644 index 00000000..4a0c7297 --- /dev/null +++ b/docs/grapheneapi.graphenewsrpc.rst @@ -0,0 +1,7 @@ +grapheneapi\.graphenewsrpc module +================================= + +.. automodule:: grapheneapi.graphenewsrpc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.http.rst b/docs/grapheneapi.http.rst new file mode 100644 index 00000000..100110c1 --- /dev/null +++ b/docs/grapheneapi.http.rst @@ -0,0 +1,7 @@ +grapheneapi\.http module +======================== + +.. automodule:: grapheneapi.http + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.rpc.rst b/docs/grapheneapi.rpc.rst new file mode 100644 index 00000000..b0f99c8d --- /dev/null +++ b/docs/grapheneapi.rpc.rst @@ -0,0 +1,7 @@ +grapheneapi\.rpc module +======================= + +.. automodule:: grapheneapi.rpc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.rst b/docs/grapheneapi.rst new file mode 100644 index 00000000..d2f58dea --- /dev/null +++ b/docs/grapheneapi.rst @@ -0,0 +1,27 @@ +grapheneapi package +=================== + +Submodules +---------- + +.. toctree:: + + grapheneapi.api + grapheneapi.exceptions + grapheneapi.grapheneapi + grapheneapi.grapheneclient + grapheneapi.graphenehttprpc + grapheneapi.graphenews + grapheneapi.graphenewsprotocol + grapheneapi.graphenewsrpc + grapheneapi.http + grapheneapi.rpc + grapheneapi.websocket + +Module contents +--------------- + +.. automodule:: grapheneapi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/grapheneapi.websocket.rst b/docs/grapheneapi.websocket.rst new file mode 100644 index 00000000..c3c33a26 --- /dev/null +++ b/docs/grapheneapi.websocket.rst @@ -0,0 +1,7 @@ +grapheneapi\.websocket module +============================= + +.. automodule:: grapheneapi.websocket + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.account.rst b/docs/graphenebase.account.rst new file mode 100644 index 00000000..9599e5bb --- /dev/null +++ b/docs/graphenebase.account.rst @@ -0,0 +1,7 @@ +graphenebase\.account module +============================ + +.. automodule:: graphenebase.account + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.base58.rst b/docs/graphenebase.base58.rst new file mode 100644 index 00000000..fe703e1c --- /dev/null +++ b/docs/graphenebase.base58.rst @@ -0,0 +1,7 @@ +graphenebase\.base58 module +=========================== + +.. automodule:: graphenebase.base58 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.bip38.rst b/docs/graphenebase.bip38.rst new file mode 100644 index 00000000..8d86d0e2 --- /dev/null +++ b/docs/graphenebase.bip38.rst @@ -0,0 +1,7 @@ +graphenebase\.bip38 module +========================== + +.. automodule:: graphenebase.bip38 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.chains.rst b/docs/graphenebase.chains.rst new file mode 100644 index 00000000..3bfad793 --- /dev/null +++ b/docs/graphenebase.chains.rst @@ -0,0 +1,7 @@ +graphenebase\.chains module +=========================== + +.. automodule:: graphenebase.chains + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.dictionary.rst b/docs/graphenebase.dictionary.rst new file mode 100644 index 00000000..126a67dc --- /dev/null +++ b/docs/graphenebase.dictionary.rst @@ -0,0 +1,7 @@ +graphenebase\.dictionary module +=============================== + +.. automodule:: graphenebase.dictionary + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.ecdsa.rst b/docs/graphenebase.ecdsa.rst new file mode 100644 index 00000000..6449ad2a --- /dev/null +++ b/docs/graphenebase.ecdsa.rst @@ -0,0 +1,7 @@ +graphenebase\.ecdsa module +========================== + +.. automodule:: graphenebase.ecdsa + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.objects.rst b/docs/graphenebase.objects.rst new file mode 100644 index 00000000..362c7e9a --- /dev/null +++ b/docs/graphenebase.objects.rst @@ -0,0 +1,7 @@ +graphenebase\.objects module +============================ + +.. automodule:: graphenebase.objects + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.objecttypes.rst b/docs/graphenebase.objecttypes.rst new file mode 100644 index 00000000..17c675f3 --- /dev/null +++ b/docs/graphenebase.objecttypes.rst @@ -0,0 +1,7 @@ +graphenebase\.objecttypes module +================================ + +.. automodule:: graphenebase.objecttypes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.operationids.rst b/docs/graphenebase.operationids.rst new file mode 100644 index 00000000..9b20425d --- /dev/null +++ b/docs/graphenebase.operationids.rst @@ -0,0 +1,7 @@ +graphenebase\.operationids module +================================= + +.. automodule:: graphenebase.operationids + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.operations.rst b/docs/graphenebase.operations.rst new file mode 100644 index 00000000..41868ed4 --- /dev/null +++ b/docs/graphenebase.operations.rst @@ -0,0 +1,7 @@ +graphenebase\.operations module +=============================== + +.. automodule:: graphenebase.operations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.rst b/docs/graphenebase.rst new file mode 100644 index 00000000..4030b4f7 --- /dev/null +++ b/docs/graphenebase.rst @@ -0,0 +1,29 @@ +graphenebase package +==================== + +Submodules +---------- + +.. toctree:: + + graphenebase.account + graphenebase.base58 + graphenebase.bip38 + graphenebase.chains + graphenebase.dictionary + graphenebase.ecdsa + graphenebase.objects + graphenebase.objecttypes + graphenebase.operationids + graphenebase.operations + graphenebase.signedtransactions + graphenebase.transactions + graphenebase.types + +Module contents +--------------- + +.. automodule:: graphenebase + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.signedtransactions.rst b/docs/graphenebase.signedtransactions.rst new file mode 100644 index 00000000..c97e5c75 --- /dev/null +++ b/docs/graphenebase.signedtransactions.rst @@ -0,0 +1,7 @@ +graphenebase\.signedtransactions module +======================================= + +.. automodule:: graphenebase.signedtransactions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.transactions.rst b/docs/graphenebase.transactions.rst new file mode 100644 index 00000000..179c3ee8 --- /dev/null +++ b/docs/graphenebase.transactions.rst @@ -0,0 +1,7 @@ +graphenebase\.transactions module +================================= + +.. automodule:: graphenebase.transactions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/graphenebase.types.rst b/docs/graphenebase.types.rst new file mode 100644 index 00000000..eba082d6 --- /dev/null +++ b/docs/graphenebase.types.rst @@ -0,0 +1,7 @@ +graphenebase\.types module +========================== + +.. automodule:: graphenebase.types + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index bbc95e8a..18fcc0fe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,6 +46,15 @@ Graphene API witness wallet +Packages +-------- + +.. toctree:: + :maxdepth: 3 + + grapheneapi + graphenebase + Indices and tables ================== diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 00000000..1d4cd316 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,8 @@ +python-graphene +=============== + +.. toctree:: + :maxdepth: 6 + + grapheneapi + graphenebase