From e1be37dfe2dd28a9e0e2fc2f2aabf40512adc4c1 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Tue, 28 Jul 2015 09:27:11 +0200 Subject: [PATCH 1/1] initial ci --- LICENSE | 22 ++++++++++++++++++++++ README.md | 26 ++++++++++++++++++++++++++ doxypages | 14 ++++++++++++++ 3 files changed, 62 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100755 doxypages diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..34859a1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +Copyright (c) 2015, Michael Wallner . +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f314d53 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Doxygen gh-pages + +Runs doxygen on the current checkout into your gh-pages branch. + +## Usage: + + cd project.git + ../doxygen_gh-pages.git/doxypages < Doxyfile + git push origin gh-pages + +## What it does: + +* Creates a temporary workdir of the gh-pages branch with git-new-workdir +* Runs doxygen with `OUTPUT_DIRECTORY=$TEMPDIR` +* Commits changes to gh-pages +* Cleans up `$TEMPDIR` + +Simple enough, but I didn't want to maintain it in several different repos. + +## Prerequisites: + +* git +* git-new-workdir +* doxygen + + diff --git a/doxypages b/doxypages new file mode 100755 index 0000000..9592f08 --- /dev/null +++ b/doxypages @@ -0,0 +1,14 @@ +#!/bin/sh +set -e + +TMPDIR=$(mktemp -d) +git-new-workdir . $TMPDIR gh-pages + +(cat -; echo "OUTPUT_DIRECTORY=$TMPDIR") | doxygen - + +cd $TMPDIR +git add -A +git commit -m "update docs" +cd - +rm -r $TMPDIR + -- 2.30.2