mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 02:09:17 +02:00
improve docs and structure
see online snapshot: https://m.devpi.net/hpk/dev/deltachat/0.5.dev0/+doc/index.html
This commit is contained in:
parent
099306408e
commit
8683de19e3
11 changed files with 253 additions and 213 deletions
3
python/doc/_templates/globaltoc.html
vendored
3
python/doc/_templates/globaltoc.html
vendored
|
@ -4,7 +4,8 @@
|
|||
<ul>
|
||||
<li><a href="{{ pathto('index') }}">Home</a></li>
|
||||
<li><a href="{{ pathto('install') }}">Install</a></li>
|
||||
<li><a href="{{ pathto('api') }}">API Documentation</a></li>
|
||||
<li><a href="{{ pathto('api') }}">High level API</a></li>
|
||||
<li><a href="{{ pathto('capi') }}">Low level API</a></li>
|
||||
</ul>
|
||||
<b>External Links:</b>
|
||||
<ul>
|
||||
|
|
2
python/doc/_templates/sidebarintro.html
vendored
2
python/doc/_templates/sidebarintro.html
vendored
|
@ -1,4 +1,4 @@
|
|||
<h3>deltachat {{release}}</h3>
|
||||
<p>
|
||||
Bindings for <a href="https://delta.chat">Delta.chat</a>
|
||||
<a href="https://delta.chat">Delta.chat</a> Python Bindings
|
||||
</p>
|
||||
|
|
|
@ -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:
|
||||
|
||||
|
|
7
python/doc/capi.rst
Normal file
7
python/doc/capi.rst
Normal file
|
@ -0,0 +1,7 @@
|
|||
|
||||
Low Level API Reference
|
||||
===================================
|
||||
|
||||
.. automodule:: deltachat.capi.lib
|
||||
:members:
|
||||
|
|
@ -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 <https://deltachat.github.io/api/index.html>`_.
|
||||
|
||||
- **low level bindings to deltachat-core**: ``deltachat.capi.lib`` exposes
|
||||
a CFFI-interface to the `deltachat-core C-API <https://deltachat.github.io/api/index.html>`.
|
||||
- :doc:`api` [work-in-progress] is a high level interface to deltachat-core which aims
|
||||
to be memory safe and thoroughly tested through continous tox/pytest runs.
|
||||
|
||||
- **higher level bindings**: :class:`deltachat.Account` serves as a high
|
||||
level object through which you can configure, send and receive messages,
|
||||
create and manage groups.
|
||||
|
||||
Getting started
|
||||
-----------------------------------------
|
||||
|
@ -22,6 +20,7 @@ Getting started
|
|||
install
|
||||
getting-started
|
||||
api
|
||||
capi
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue