diff options
| author | drebs <drebs@riseup.net> | 2017-09-28 16:58:45 -0300 |
|---|---|---|
| committer | drebs <drebs@riseup.net> | 2017-09-28 16:58:45 -0300 |
| commit | 638824139e0f90ac917b5827e8f38d47d1a6cda8 (patch) | |
| tree | be04269af9ae6a6fbb39b842fc474b71620fa303 /docs/api | |
| parent | 9694b5424507c03a2494713354e8a20a2f8a8d43 (diff) | |
[doc] add api reference to the docs
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/attachments.rst | 11 | ||||
| -rw-r--r-- | docs/api/blobs.rst | 11 | ||||
| -rw-r--r-- | docs/api/client.rst | 8 | ||||
| -rw-r--r-- | docs/api/server.rst | 6 |
4 files changed, 36 insertions, 0 deletions
diff --git a/docs/api/attachments.rst b/docs/api/attachments.rst new file mode 100644 index 00000000..80b81d67 --- /dev/null +++ b/docs/api/attachments.rst @@ -0,0 +1,11 @@ +Client-side Attachments API +=========================== + +Soledad Documents implement the ``IDocumentWithAttachment`` API that associates +:ref:`blobs` with documents. + +.. autoclass:: leap.soledad.client._document.IDocumentWithAttachment + :members: + :undoc-members: + :special-members: + :show-inheritance: diff --git a/docs/api/blobs.rst b/docs/api/blobs.rst new file mode 100644 index 00000000..fbf31e1c --- /dev/null +++ b/docs/api/blobs.rst @@ -0,0 +1,11 @@ +Client-side Blobs API +===================== + +The Soledad Client object has a ``blobmanager`` property which is responsible +for handling blobs. + +.. autoclass:: leap.soledad.client._db.blobs.BlobManager + :members: + :special-members: __init__ + :undoc-members: + :show-inheritance: diff --git a/docs/api/client.rst b/docs/api/client.rst new file mode 100644 index 00000000..7be3f763 --- /dev/null +++ b/docs/api/client.rst @@ -0,0 +1,8 @@ +Soledad Client API +================== + +.. autoclass:: leap.soledad.client.Soledad + :members: + :undoc-members: + :special-members: __init__ + :show-inheritance: diff --git a/docs/api/server.rst b/docs/api/server.rst new file mode 100644 index 00000000..d93e41ed --- /dev/null +++ b/docs/api/server.rst @@ -0,0 +1,6 @@ +Soledad Server API +================== + +.. automodule:: leap.soledad.server + :members: + :show-inheritance: |