mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +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
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -43,6 +43,7 @@ po/remove-potcdate.sed
|
||||||
po/*.gmo
|
po/*.gmo
|
||||||
po/*.insert-header
|
po/*.insert-header
|
||||||
/docs/html/
|
/docs/html/
|
||||||
|
/docs/xml/
|
||||||
|
|
||||||
# ignore other files
|
# ignore other files
|
||||||
.DS_Store
|
.DS_Store
|
||||||
|
|
|
@ -8,6 +8,7 @@ addons:
|
||||||
- python3-pip
|
- python3-pip
|
||||||
- python3.5
|
- python3.5
|
||||||
- g++-7
|
- g++-7
|
||||||
|
- doxygen
|
||||||
|
|
||||||
language: c
|
language: c
|
||||||
|
|
||||||
|
@ -30,6 +31,8 @@ script:
|
||||||
- mkdir -p builddir && cd builddir && meson && ninja -v && sudo ninja install
|
- 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
|
- export LD_LIBRARY_PATH=/usr/local/lib/x86_64-linux-gnu:$LD_LIBRARY_PATH
|
||||||
- sudo ldconfig -v
|
- sudo ldconfig -v
|
||||||
|
- cd ../docs
|
||||||
|
- doxygen
|
||||||
- cd ../python
|
- cd ../python
|
||||||
- virtualenv -p /usr/bin/python3.5 venv
|
- virtualenv -p /usr/bin/python3.5 venv
|
||||||
- source venv/bin/activate
|
- source venv/bin/activate
|
||||||
|
|
|
@ -1911,7 +1911,7 @@ MAN_LINKS = NO
|
||||||
# captures the structure of the code including all documentation.
|
# captures the structure of the code including all documentation.
|
||||||
# The default value is: NO.
|
# 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
|
# 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
|
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||||
|
|
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('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('lapi') }}">low level API</a></li>
|
||||||
|
<li><a href="{{ pathto('capi') }}">C deltachat.h</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<b>external links:</b>
|
<b>external links:</b>
|
||||||
<ul>
|
<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.intersphinx',
|
||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
|
'breathe',
|
||||||
#'sphinx.ext.githubpages',
|
#'sphinx.ext.githubpages',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -92,6 +93,14 @@ pygments_style = 'sphinx'
|
||||||
#modindex_common_prefix = []
|
#modindex_common_prefix = []
|
||||||
|
|
||||||
|
|
||||||
|
# -- breathe options ------
|
||||||
|
|
||||||
|
breathe_projects = {
|
||||||
|
"deltachat": "../../docs/xml/"
|
||||||
|
}
|
||||||
|
|
||||||
|
breathe_default_project = "deltachat"
|
||||||
|
|
||||||
# -- Options for HTML output ---------------------------------------------------
|
# -- Options for HTML output ---------------------------------------------------
|
||||||
|
|
||||||
sys.path.append(os.path.abspath('_themes'))
|
sys.path.append(os.path.abspath('_themes'))
|
||||||
|
|
|
@ -27,6 +27,7 @@ getting started
|
||||||
changelog
|
changelog
|
||||||
api
|
api
|
||||||
capi
|
capi
|
||||||
|
lapi
|
||||||
|
|
||||||
..
|
..
|
||||||
Indices and tables
|
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:
|
||||||
|
|
|
@ -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
|
|
|
@ -32,6 +32,7 @@ commands =
|
||||||
usedevelop = True
|
usedevelop = True
|
||||||
deps =
|
deps =
|
||||||
sphinx
|
sphinx
|
||||||
|
breathe
|
||||||
|
|
||||||
whitelist_externals = make
|
whitelist_externals = make
|
||||||
changedir = doc
|
changedir = doc
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue