initial ci
[m6w6/doxygen_gh-pages] / README.md
1 # Doxygen gh-pages
2
3 Runs doxygen on the current checkout into your gh-pages branch.
4
5 ## Usage:
6
7 cd project.git
8 ../doxygen_gh-pages.git/doxypages < Doxyfile
9 git push origin gh-pages
10
11 ## What it does:
12
13 * Creates a temporary workdir of the gh-pages branch with git-new-workdir
14 * Runs doxygen with `OUTPUT_DIRECTORY=$TEMPDIR`
15 * Commits changes to gh-pages
16 * Cleans up `$TEMPDIR`
17
18 Simple enough, but I didn't want to maintain it in several different repos.
19
20 ## Prerequisites:
21
22 * git
23 * git-new-workdir
24 * doxygen
25
26