diff --git a/README.md b/README.md index 4d58c18b..6775adf6 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://travis-ci.org/deltachat/deltachat-core.svg?branch=master)](https://travis-ci.org/deltachat/deltachat-core) The _Delta Chat Core Library_ is written in cross-platform **C**, -documented at . +documented at . ## Building the C-library diff --git a/docs/README.md b/docs/README.md index 4d644b82..71f32c34 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,4 @@ to get the api documentation, -- call doxygen in this directory -- or read it online at -- or clone `https://github.com/deltachat/api` +- call doxygen in this directory and browse the `html` subdirectory +- or read it online at diff --git a/docs/update.sh b/docs/update.sh deleted file mode 100755 index cd4ca65c..00000000 --- a/docs/update.sh +++ /dev/null @@ -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 - - diff --git a/python/doc/index.rst b/python/doc/index.rst index db22cefa..3473623c 100644 --- a/python/doc/index.rst +++ b/python/doc/index.rst @@ -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 `_. + `deltachat-core C-API `_. - :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.