yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-04 18:29:19 +02:00
Code Issues Releases Wiki Activity

some further improvements -- and making all captions lower-case for the fun of it :)

Browse source
This commit is contained in:
holger krekel 2018-09-14 18:25:44 +02:00
parent 8683de19e3
commit 959ac73122
8 changed files with 27 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

16
python/doc/_templates/globaltoc.html vendored
View file

@ -1,17 +1,15 @@
<h3><a href="{{ pathto('contents') }}">{{ _('Table Of Contents') }}</a></h3>
<ul> <ul>
<li><a href="{{ pathto('index') }}">Home</a></li> <li><a href="{{ pathto('index') }}">index</a></li>
<li><a href="{{ pathto('install') }}">Install</a></li> <li><a href="{{ pathto('install') }}">install</a></li>
<li><a href="{{ pathto('api') }}">High level API</a></li> <li><a href="{{ pathto('api') }}">high level API</a></li>
<li><a href="{{ pathto('capi') }}">Low level API</a></li> <li><a href="{{ pathto('capi') }}">low level API</a></li>
</ul> </ul>
<b>External Links:</b> <b>external links:</b>
<ul> <ul>
<li><a href="https://github.com/deltachat/deltachat-core">Github repository</a></li> <li><a href="https://github.com/deltachat/deltachat-core">github repository</a></li>
<!-- <li><a href="https://lists.codespeak.net/postorius/lists/muacrypt.lists.codespeak.net">Mailing list</></li> <--> <!-- <li><a href="https://lists.codespeak.net/postorius/lists/muacrypt.lists.codespeak.net">Mailing list</></li> <-->
<li><a href="https://pypi.python.org/pypi/deltachat">PyPI: deltachat</a></li> <li><a href="https://pypi.python.org/pypi/deltachat">pypi: deltachat</a></li>
</ul> </ul>
<b>#deltachat [freenode]</b> <b>#deltachat [freenode]</b>

2
python/doc/_templates/sidebarintro.html vendored
View file

@ -1,4 +1,4 @@
<h3>deltachat {{release}}</h3> <h3>deltachat {{release}}</h3>
<p> <p>
<a href="https://delta.chat">Delta.chat</a> Python Bindings <a href="https://delta.chat">delta.chat</a> python bindings
</p> </p>

4
python/doc/api.rst
View file

@ -1,6 +1,6 @@
deltachat high level API Reference high level API reference
=================================== ========================
.. note:: .. note::

2
python/doc/capi.rst
View file

@ -1,5 +1,5 @@
Low Level API Reference low level API reference
=================================== ===================================
.. automodule:: deltachat.capi.lib .. automodule:: deltachat.capi.lib

2
python/doc/conf.py
View file

@ -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 # 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 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large. # pixels large.
#html_favicon = None html_favicon = '_static/favicon.ico'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,

4
python/doc/getting-started.rst → python/doc/examples.rst
View file

@ -1,7 +1,7 @@
Getting started examples
================ ========
:: ::

14
python/doc/index.rst
View file

@ -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: of the https://delta.chat messaging ecosystem:
- :doc:`capi` is a lowlevel CFFI-binding to the - :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. to be memory safe and thoroughly tested through continous tox/pytest runs.
Getting started getting started
----------------------------------------- ---------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
install install
getting-started examples
api
capi
.. toctree:: .. toctree::
:hidden: :hidden:
links links
changelog changelog
api
capi
.. ..
Indices and tables Indices and tables

9
python/doc/install.rst
View file

@ -1,12 +1,12 @@
Building and Installing deltachat building and installing deltachat
====================================== ======================================
This package provides bindings to the delta-core_ C-library This package provides bindings to the delta-core_ C-library
which provides imap/smtp/crypto handling as well as chat/group/messages which provides imap/smtp/crypto handling as well as chat/group/messages
handling to Android, Desktop and IO user interfaces. handling to Android, Desktop and IO user interfaces.
Install build
------- -------
.. note:: .. note::
@ -16,6 +16,9 @@ Install
First you need to execute all the build steps to install the delta-core C-library, 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 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:: Presuming you have the delta-core library installed, you can then from the root of the repo::
cd python cd python
@ -26,7 +29,7 @@ Afterwards you should be able to successfully import the bindings::
python -c "import deltachat" python -c "import deltachat"
Running tests running tests
------------- -------------
Install the delta-core C-library and the deltachat bindings (see _Install) Install the delta-core C-library and the deltachat bindings (see _Install)