mirror of
https://github.com/chatmail/core.git
synced 2026-05-09 01:46:30 +03:00
try generating and uploading doxygen docs (#697)
This commit is contained in:
@@ -4,6 +4,9 @@ executors:
|
|||||||
docker:
|
docker:
|
||||||
- image: filecoin/rust:latest
|
- image: filecoin/rust:latest
|
||||||
working_directory: /mnt/crate
|
working_directory: /mnt/crate
|
||||||
|
doxygen:
|
||||||
|
docker:
|
||||||
|
- image: hrektts/doxygen
|
||||||
|
|
||||||
restore-workspace: &restore-workspace
|
restore-workspace: &restore-workspace
|
||||||
attach_workspace:
|
attach_workspace:
|
||||||
@@ -113,6 +116,18 @@ jobs:
|
|||||||
target: "aarch64-linux-android"
|
target: "aarch64-linux-android"
|
||||||
|
|
||||||
|
|
||||||
|
build_doxygen:
|
||||||
|
executor: doxygen
|
||||||
|
steps:
|
||||||
|
- checkout
|
||||||
|
- run: bash ci_scripts/run-doxygen.sh
|
||||||
|
- run: mkdir -p workspace/c-docs
|
||||||
|
- run: cp -av deltachat-ffi/{html,xml} workspace/c-docs/
|
||||||
|
- persist_to_workspace:
|
||||||
|
root: workspace
|
||||||
|
paths:
|
||||||
|
- c-docs
|
||||||
|
|
||||||
build_test_docs_wheel:
|
build_test_docs_wheel:
|
||||||
docker:
|
docker:
|
||||||
- image: deltachat/coredeps
|
- image: deltachat/coredeps
|
||||||
@@ -148,7 +163,7 @@ jobs:
|
|||||||
at: workspace
|
at: workspace
|
||||||
- run: pyenv global 3.5.2
|
- run: pyenv global 3.5.2
|
||||||
- run: ls -laR workspace
|
- run: ls -laR workspace
|
||||||
- run: ci_scripts/ci_upload.sh workspace/py-docs workspace/wheelhouse
|
- run: ci_scripts/ci_upload.sh workspace/py-docs workspace/wheelhouse workspace/c-docs
|
||||||
|
|
||||||
clippy:
|
clippy:
|
||||||
executor: default
|
executor: default
|
||||||
@@ -166,12 +181,15 @@ workflows:
|
|||||||
test:
|
test:
|
||||||
jobs:
|
jobs:
|
||||||
- cargo_fetch
|
- cargo_fetch
|
||||||
|
- build_doxygen
|
||||||
|
|
||||||
- build_test_docs_wheel:
|
- build_test_docs_wheel:
|
||||||
requires:
|
requires:
|
||||||
- cargo_fetch
|
- cargo_fetch
|
||||||
- upload_docs_wheels:
|
- upload_docs_wheels:
|
||||||
requires:
|
requires:
|
||||||
- build_test_docs_wheel
|
- build_test_docs_wheel
|
||||||
|
- build_doxygen
|
||||||
- rustfmt:
|
- rustfmt:
|
||||||
requires:
|
requires:
|
||||||
- cargo_fetch
|
- cargo_fetch
|
||||||
|
|||||||
@@ -7,9 +7,9 @@ fi
|
|||||||
|
|
||||||
set -xe
|
set -xe
|
||||||
|
|
||||||
#DOXYDOCDIR=${1:?directory where doxygen docs to be found}
|
|
||||||
PYDOCDIR=${1:?directory with python docs}
|
PYDOCDIR=${1:?directory with python docs}
|
||||||
WHEELHOUSEDIR=${2:?directory with pre-built wheels}
|
WHEELHOUSEDIR=${2:?directory with pre-built wheels}
|
||||||
|
DOXYDOCDIR=${3:?directory where doxygen docs to be found}
|
||||||
|
|
||||||
export BRANCH=${CIRCLE_BRANCH:?specify branch for uploading purposes}
|
export BRANCH=${CIRCLE_BRANCH:?specify branch for uploading purposes}
|
||||||
|
|
||||||
@@ -22,10 +22,10 @@ rsync -avz \
|
|||||||
delta@py.delta.chat:build/${BRANCH}
|
delta@py.delta.chat:build/${BRANCH}
|
||||||
|
|
||||||
# C docs to c.delta.chat
|
# C docs to c.delta.chat
|
||||||
#rsync -avz \
|
rsync -avz \
|
||||||
# -e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" \
|
-e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" \
|
||||||
# "$DOXYDOCDIR/html/" \
|
"$DOXYDOCDIR/html/" \
|
||||||
# delta@py.delta.chat:build-c/${BRANCH}
|
delta@c.delta.chat:build-c/${BRANCH}
|
||||||
|
|
||||||
echo -----------------------
|
echo -----------------------
|
||||||
echo upload wheels
|
echo upload wheels
|
||||||
|
|||||||
7
ci_scripts/run-doxygen.sh
Executable file
7
ci_scripts/run-doxygen.sh
Executable file
@@ -0,0 +1,7 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
cd deltachat-ffi
|
||||||
|
doxygen
|
||||||
|
|
||||||
1
python/doc/_templates/globaltoc.html
vendored
1
python/doc/_templates/globaltoc.html
vendored
@@ -6,7 +6,6 @@
|
|||||||
<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('lapi') }}">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>
|
||||||
|
|||||||
@@ -2,7 +2,13 @@
|
|||||||
low level API reference
|
low level API reference
|
||||||
===================================
|
===================================
|
||||||
|
|
||||||
for full C-docs, defines and function checkout :doc:`capi`
|
for full doxygen-generated C-docs, defines and functions please checkout
|
||||||
|
|
||||||
|
https://c.delta.chat
|
||||||
|
|
||||||
|
|
||||||
|
Python low-level capi calls
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
|
||||||
.. automodule:: deltachat.capi.lib
|
.. automodule:: deltachat.capi.lib
|
||||||
|
|||||||
Reference in New Issue
Block a user