mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-05 19:42:04 +02:00
link to new http://c.delta.chat doc, remove tool for creating the doc on github.io
This commit is contained in:
parent
9ebc94fa17
commit
9273e1e458
4 changed files with 4 additions and 45 deletions
|
@ -3,7 +3,7 @@
|
|||
[](https://travis-ci.org/deltachat/deltachat-core)
|
||||
|
||||
The _Delta Chat Core Library_ is written in cross-platform **C**,
|
||||
documented at <https://deltachat.github.io/api/>.
|
||||
documented at <https://c.delta.chat>.
|
||||
|
||||
|
||||
## Building the C-library
|
||||
|
|
|
@ -1,5 +1,4 @@
|
|||
to get the api documentation,
|
||||
|
||||
- call doxygen in this directory
|
||||
- or read it online at <https://deltachat.github.io/api/>
|
||||
- or clone `https://github.com/deltachat/api`
|
||||
- call doxygen in this directory and browse the `html` subdirectory
|
||||
- or read it online at <https://c.delta.chat>
|
||||
|
|
|
@ -1,40 +0,0 @@
|
|||
# this script generates the c-api html-help-pages
|
||||
# from the c-core-source using `doxygen`
|
||||
|
||||
UPLOADDIR="../../api"
|
||||
|
||||
doxygen
|
||||
|
||||
|
||||
# HACK: we use the doxygen commands @defgroup and @addtogroup to sort #define's,
|
||||
# however, doxygen files them under the menu entry "Modules".
|
||||
# with the following lines, we correct the menu entry title.
|
||||
# if anyone sees a more elegant solution for this, please change it :)
|
||||
replace_in_html() {
|
||||
for currfile in *.js; do
|
||||
sed -i "s/$1/$2/g" $currfile
|
||||
done
|
||||
for currfile in *.html; do
|
||||
sed -i "s/$1/$2/g" $currfile
|
||||
done
|
||||
}
|
||||
cd html
|
||||
replace_in_html "Modules" "Constants"
|
||||
replace_in_html "all modules" "all constants"
|
||||
cd ..
|
||||
|
||||
|
||||
mkdir -p ${UPLOADDIR}/docs/
|
||||
cp -r html/* ${UPLOADDIR}/docs/
|
||||
read -p "if not errors are printed above, press ENTER to commit and push the changes"
|
||||
|
||||
pushd . > /dev/null
|
||||
|
||||
cd ${UPLOADDIR}
|
||||
git add docs/
|
||||
git commit -am "update docs"
|
||||
git push
|
||||
|
||||
popd > /dev/null
|
||||
|
||||
|
|
@ -5,7 +5,7 @@ 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
|
||||
`deltachat-core C-API <https://deltachat.github.io/api/index.html>`_.
|
||||
`deltachat-core C-API <https://c.delta.chat>`_.
|
||||
|
||||
- :doc:`api` [work-in-progress] is a high level interface to deltachat-core which aims
|
||||
to be memory safe and thoroughly tested through continous tox/pytest runs.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue