mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-10 05:59:44 +00:00
7c9d5ace14
* Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly
14 lines
432 B
Bash
14 lines
432 B
Bash
#!/bin/bash
|
|
|
|
source util/travis_push.sh
|
|
|
|
if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip docs]"* ]] ; then
|
|
if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/api_.*'; then
|
|
echo "Generating API docs..."
|
|
rm -rf doxygen
|
|
doxygen Doxyfile
|
|
moxygen -a -g -o -q docs/api_%s.md doxygen/xml
|
|
git add docs/api_*
|
|
git commit -m'autogenerated api docs for ${TRAVIS_COMMIT_RANGE}' || true
|
|
fi
|
|
fi
|