From a2a23f778d1a445eadb7b84a56ea01b5787b9461 Mon Sep 17 00:00:00 2001
From: holger krekel <holger@merlinux.eu>
Date: Sun, 16 Sep 2018 22:27:42 +0200
Subject: [PATCH] integrate doxygen's deltachat.h docs into sphinx output

---
 .gitignore                           |  1 +
 .travis.yml                          |  3 +++
 docs/Doxyfile                        |  2 +-
 python/doc/_templates/globaltoc.html |  3 ++-
 python/doc/capi.rst                  | 15 +++++++++++----
 python/doc/conf.py                   |  9 +++++++++
 python/doc/index.rst                 |  1 +
 python/doc/lapi.rst                  | 10 ++++++++++
 python/liveconfig.txt                |  4 ----
 python/tox.ini                       |  1 +
 10 files changed, 39 insertions(+), 10 deletions(-)
 create mode 100644 python/doc/lapi.rst
 delete mode 100644 python/liveconfig.txt

diff --git a/.gitignore b/.gitignore
index fc2dde45..f287a1a2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -43,6 +43,7 @@ po/remove-potcdate.sed
 po/*.gmo
 po/*.insert-header
 /docs/html/
+/docs/xml/
 
 # ignore other files
 .DS_Store
diff --git a/.travis.yml b/.travis.yml
index 7e334059..b54fa0b2 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -8,6 +8,7 @@ addons:
     - python3-pip
     - python3.5
     - g++-7
+    - doxygen
 
 language: c
 
@@ -30,6 +31,8 @@ script:
   - mkdir -p builddir && cd builddir && meson && ninja -v && sudo ninja install 
   - export LD_LIBRARY_PATH=/usr/local/lib/x86_64-linux-gnu:$LD_LIBRARY_PATH 
   - sudo ldconfig -v 
+  - cd ../docs
+  - doxygen
   - cd ../python
   - virtualenv -p /usr/bin/python3.5 venv
   - source venv/bin/activate
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 6edf48ae..e055287d 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -1911,7 +1911,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
diff --git a/python/doc/_templates/globaltoc.html b/python/doc/_templates/globaltoc.html
index 6d0d51fe..c649d5df 100644
--- a/python/doc/_templates/globaltoc.html
+++ b/python/doc/_templates/globaltoc.html
@@ -5,7 +5,8 @@
   <li><a href="{{ pathto('index') }}">index</a></li>
   <li><a href="{{ pathto('install') }}">install</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('lapi') }}">low level API</a></li>
+  <li><a href="{{ pathto('capi') }}">C deltachat.h</a></li>
 </ul>
 <b>external links:</b>
 <ul>
diff --git a/python/doc/capi.rst b/python/doc/capi.rst
index b8a77668..493449f1 100644
--- a/python/doc/capi.rst
+++ b/python/doc/capi.rst
@@ -1,7 +1,14 @@
 
-low level API reference
-===================================
+C deltachat interface
+=====================
+
+See :doc:`lapi` for accessing many of the below functions
+through the ``deltachat.capi.lib`` namespace.
+
+.. doxygenindex::
+    :project: deltachat
+
+
+
 
-.. automodule:: deltachat.capi.lib
-    :members:
 
diff --git a/python/doc/conf.py b/python/doc/conf.py
index 5a2fc567..41664235 100644
--- a/python/doc/conf.py
+++ b/python/doc/conf.py
@@ -37,6 +37,7 @@ extensions = [
     #'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    'breathe',
     #'sphinx.ext.githubpages',
 ]
 
@@ -92,6 +93,14 @@ pygments_style = 'sphinx'
 #modindex_common_prefix = []
 
 
+# -- breathe options ------
+
+breathe_projects = {
+    "deltachat": "../../docs/xml/"
+}
+
+breathe_default_project = "deltachat"
+
 # -- Options for HTML output ---------------------------------------------------
 
 sys.path.append(os.path.abspath('_themes'))
diff --git a/python/doc/index.rst b/python/doc/index.rst
index b7638382..db22cefa 100644
--- a/python/doc/index.rst
+++ b/python/doc/index.rst
@@ -27,6 +27,7 @@ getting started
    changelog
    api
    capi
+   lapi
 
 ..
     Indices and tables
diff --git a/python/doc/lapi.rst b/python/doc/lapi.rst
new file mode 100644
index 00000000..7d04b1e3
--- /dev/null
+++ b/python/doc/lapi.rst
@@ -0,0 +1,10 @@
+
+low level API reference
+===================================
+
+for full C-docs, defines and function checkout :doc:`capi.`
+
+
+.. automodule:: deltachat.capi.lib
+    :members:
+
diff --git a/python/liveconfig.txt b/python/liveconfig.txt
deleted file mode 100644
index d31127d1..00000000
--- a/python/liveconfig.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-addr=test1@hq5.merlinux.eu mail_pw=CzCw6oV4w7WPkTy7BHn8OmC2Vak/
-addr=test2@hq5.merlinux.eu mail_pw=J/fegsglkjJyXFncgn5MAg5t8pAq
-addr=test3@hq5.merlinux.eu mail_pw=supersimplespasswort1
-addr=test4@hq5.merlinux.eu mail_pw=supersimplespasswort2
diff --git a/python/tox.ini b/python/tox.ini
index 1b0cab5d..8fab1f18 100644
--- a/python/tox.ini
+++ b/python/tox.ini
@@ -32,6 +32,7 @@ commands =
 usedevelop = True
 deps =
     sphinx
+    breathe
 
 whitelist_externals = make
 changedir = doc