mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 02:09:17 +02:00
integrate doxygen's deltachat.h docs into sphinx output
This commit is contained in:
parent
3d30a208c1
commit
a2a23f778d
10 changed files with 39 additions and 10 deletions
3
python/doc/_templates/globaltoc.html
vendored
3
python/doc/_templates/globaltoc.html
vendored
|
@ -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>
|
||||
|
|
|
@ -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:
|
||||
|
||||
|
|
|
@ -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'))
|
||||
|
|
|
@ -27,6 +27,7 @@ getting started
|
|||
changelog
|
||||
api
|
||||
capi
|
||||
lapi
|
||||
|
||||
..
|
||||
Indices and tables
|
||||
|
|
10
python/doc/lapi.rst
Normal file
10
python/doc/lapi.rst
Normal file
|
@ -0,0 +1,10 @@
|
|||
|
||||
low level API reference
|
||||
===================================
|
||||
|
||||
for full C-docs, defines and function checkout :doc:`capi.`
|
||||
|
||||
|
||||
.. automodule:: deltachat.capi.lib
|
||||
:members:
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue