Automated Doxygen documentation with Travis-CI

This commit is contained in:
redtide 2019-12-02 02:35:58 +01:00
parent 5d8e758724
commit 200d7153ca
7 changed files with 27 additions and 18 deletions

View file

@ -13,6 +13,6 @@ indent_style = space
insert_final_newline = true insert_final_newline = true
trim_trailing_whitespace = true trim_trailing_whitespace = true
[*.{ttl,ttl.in}] [*.{ttl,ttl.in,yml}]
indent_size = 2 indent_size = 2
indent_style = space indent_style = space

4
.gitignore vendored
View file

@ -19,10 +19,14 @@ clients/sfizz_jack
clients/sfzprint clients/sfzprint
# gh-pages unstaged files: # gh-pages unstaged files:
_api/
_site/ _site/
.bundle/ .bundle/
api/ api/
assets/ assets/
node_modules/ node_modules/
.jekyll-cache
.jekyll-metadata
.sass-cache
*.lock *.lock
*.sublime-* *.sublime-*

View file

@ -11,6 +11,7 @@ matrix:
packages: packages:
- gcc-8 - gcc-8
- g++-8 - g++-8
- doxygen
env: env:
- MATRIX_EVAL="CC=gcc-8 && CXX=g++-8" - MATRIX_EVAL="CC=gcc-8 && CXX=g++-8"
@ -27,10 +28,12 @@ script:
- sh ${TRAVIS_BUILD_DIR}/.travis/script.sh - sh ${TRAVIS_BUILD_DIR}/.travis/script.sh
after_failure: after_failure:
- sh ${TRAVIS_BUILD_DIR}/.travis/after_failure.sh - sh ${TRAVIS_BUILD_DIR}/.travis/discord_webhook.sh failure
after_success: after_success:
- sh ${TRAVIS_BUILD_DIR}/.travis/after_success.sh - sh ${TRAVIS_BUILD_DIR}/.travis/discord_webhook.sh success
- sh ${TRAVIS_BUILD_DIR}/.travis/update_dox.sh
- sh ${TRAVIS_BUILD_DIR}/.travis/deploy.sh
deploy: deploy:
provider: releases provider: releases

View file

@ -1,11 +0,0 @@
#!/bin/bash
set -e
# Travis Webhook
wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
chmod +x send.sh
./send.sh success $WEBHOOK_URL
# Deploy
./deploy.sh

View file

@ -5,4 +5,4 @@ set -e
# Travis Webhook # Travis Webhook
wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh wget https://raw.githubusercontent.com/DiscordHooks/travis-ci-discord-webhook/master/send.sh
chmod +x send.sh chmod +x send.sh
./send.sh failure $WEBHOOK_URL ./send.sh ${1} ${WEBHOOK_URL}

13
.travis/update_dox.sh Executable file
View file

@ -0,0 +1,13 @@
#!/bin/bash
set -e
doxygen Doxyfile
git fetch --depth=1 https://github.com/${TRAVIS_REPO_SLUG}.git refs/heads/gh-pages:refs/remotes/origin/gh-pages
git checkout origin/gh-pages
git checkout -b gh-pages
rm -rf ./api
mv _api api
git add api && git commit -m "Travis build: ${TRAVIS_BUILD_NUMBER}"
git remote add origin-pages https://${GITHUB_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git > /dev/null 2>&1
git push --quiet --set-upstream origin-pages gh-pages

View file

@ -820,8 +820,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = sfizz \ INPUT = doxygen/pages \
doxygen/pages src
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1105,7 +1105,7 @@ GENERATE_HTML = YES
# The default directory is: html. # The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = api HTML_OUTPUT = _api
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp). # generated HTML page (for example: .htm, .php, .asp).