diff --git a/python/.gitignore b/python/.gitignore new file mode 100644 index 00000000..9638ef2a --- /dev/null +++ b/python/.gitignore @@ -0,0 +1 @@ +doc/_build/ diff --git a/python/doc/_templates/globaltoc.html b/python/doc/_templates/globaltoc.html index ada0d1f6..e186857e 100644 --- a/python/doc/_templates/globaltoc.html +++ b/python/doc/_templates/globaltoc.html @@ -4,7 +4,8 @@
External Links:- Bindings for Delta.chat +Delta.chat Python Bindings
diff --git a/python/doc/api.rst b/python/doc/api.rst index c28cc6f3..7d7d4f35 100644 --- a/python/doc/api.rst +++ b/python/doc/api.rst @@ -1,10 +1,15 @@ -deltachat API Reference -============================== +deltachat high level API Reference +=================================== + +.. note:: + + This API is work in progress and may change in versions prior to 1.0. .. autosummary:: deltachat.account + deltachat.chatting account module -------------- @@ -12,3 +17,10 @@ account module .. automodule:: deltachat.account :members: + +chatting module +--------------- + +.. automodule:: deltachat.chatting + :members: + diff --git a/python/doc/capi.rst b/python/doc/capi.rst new file mode 100644 index 00000000..0de4db4a --- /dev/null +++ b/python/doc/capi.rst @@ -0,0 +1,7 @@ + +Low Level API Reference +=================================== + +.. automodule:: deltachat.capi.lib + :members: + diff --git a/python/doc/index.rst b/python/doc/index.rst index 13a41b08..060237e8 100644 --- a/python/doc/index.rst +++ b/python/doc/index.rst @@ -1,17 +1,15 @@ -deltachat: e-mail messaging/chatting API / deltachat-core C lib bindings -======================================================================== +DeltaChat Python Bindings +========================= -.. include:: links.rst +The deltachat package provides two bindings for the core C-library +of the https://delta.chat messaging ecosystem: -The deltachat library provides interfaces into the core -C-library for https://delta.chat: +- :doc:`capi` is a lowlevel CFFI-binding to the + `deltachat-core C-API