diff --git a/python/doc/_templates/globaltoc.html b/python/doc/_templates/globaltoc.html index e186857e..70535eb0 100644 --- a/python/doc/_templates/globaltoc.html +++ b/python/doc/_templates/globaltoc.html @@ -1,17 +1,15 @@ -

{{ _('Table Of Contents') }}

- -External Links: +external links: #deltachat [freenode] diff --git a/python/doc/_templates/sidebarintro.html b/python/doc/_templates/sidebarintro.html index b7c8801f..30fa436c 100644 --- a/python/doc/_templates/sidebarintro.html +++ b/python/doc/_templates/sidebarintro.html @@ -1,4 +1,4 @@

deltachat {{release}}

-Delta.chat Python Bindings +delta.chat python bindings

diff --git a/python/doc/api.rst b/python/doc/api.rst index 7d7d4f35..4683793c 100644 --- a/python/doc/api.rst +++ b/python/doc/api.rst @@ -1,6 +1,6 @@ -deltachat high level API Reference -=================================== +high level API reference +======================== .. note:: diff --git a/python/doc/capi.rst b/python/doc/capi.rst index 0de4db4a..b8a77668 100644 --- a/python/doc/capi.rst +++ b/python/doc/capi.rst @@ -1,5 +1,5 @@ -Low Level API Reference +low level API reference =================================== .. automodule:: deltachat.capi.lib diff --git a/python/doc/conf.py b/python/doc/conf.py index 79973fc2..ce512600 100644 --- a/python/doc/conf.py +++ b/python/doc/conf.py @@ -126,7 +126,7 @@ html_logo = "_static/delta-chat.svg" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = '_static/favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/python/doc/getting-started.rst b/python/doc/examples.rst similarity index 91% rename from python/doc/getting-started.rst rename to python/doc/examples.rst index a2d283a6..0d655b2c 100644 --- a/python/doc/getting-started.rst +++ b/python/doc/examples.rst @@ -1,7 +1,7 @@ -Getting started -================ +examples +======== :: diff --git a/python/doc/index.rst b/python/doc/index.rst index 060237e8..b7638382 100644 --- a/python/doc/index.rst +++ b/python/doc/index.rst @@ -1,7 +1,7 @@ -DeltaChat Python Bindings +deltachat python bindings ========================= -The deltachat package provides two bindings for the core C-library +The ``deltachat`` Python package provides two bindings for the core C-library of the https://delta.chat messaging ecosystem: - :doc:`capi` is a lowlevel CFFI-binding to the @@ -11,22 +11,22 @@ of the https://delta.chat messaging ecosystem: to be memory safe and thoroughly tested through continous tox/pytest runs. -Getting started ------------------------------------------ +getting started +--------------- .. toctree:: :maxdepth: 2 install - getting-started - api - capi + examples .. toctree:: :hidden: links changelog + api + capi .. Indices and tables diff --git a/python/doc/install.rst b/python/doc/install.rst index 44dc63e4..c1137c9f 100644 --- a/python/doc/install.rst +++ b/python/doc/install.rst @@ -1,12 +1,12 @@ -Building and Installing deltachat +building and installing deltachat ====================================== This package provides bindings to the delta-core_ C-library which provides imap/smtp/crypto handling as well as chat/group/messages handling to Android, Desktop and IO user interfaces. -Install +build ------- .. note:: @@ -16,6 +16,9 @@ Install First you need to execute all the build steps to install the delta-core C-library, see https://github.com/deltachat/deltachat-core/blob/master/README.md#build +install +------- + Presuming you have the delta-core library installed, you can then from the root of the repo:: cd python @@ -26,7 +29,7 @@ Afterwards you should be able to successfully import the bindings:: python -c "import deltachat" -Running tests +running tests ------------- Install the delta-core C-library and the deltachat bindings (see _Install)