API docs via codox, and github pages branch script

flatland · May 12, 2014 · 41828a0 · 41828a0
1 parent 0cf98c9
commit 41828a0
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ target/
 .ritz*
 .project
 .classpath
+doc/
diff --git a/build-docs.sh b/build-docs.sh
@@ -0,0 +1,18 @@
+#!/bin/sh
+
+set -e
+
+lein doc
+echo "*** Docs built ***"
+tmpdir=`mktemp -d /tmp/flatland-useful.XXXXXX`
+mv doc/** $tmpdir
+rmdir doc
+git checkout gh-pages
+mv $tmpdir/** .
+git add -Av .
+git commit -m "Updated docs"
+echo "*** gh-pages branch updated ***"
+rmdir $tmpdir
+git checkout -
+echo "Run this to complete:"
+echo "git push origin gh-pages:gh-pages"
diff --git a/project.clj b/project.clj
@@ -9,4 +9,5 @@
                  [org.clojure/tools.reader "0.7.2"]]
   :aliases {"testall" ["with-profile" "dev,default:dev,1.3,default:dev,1.4,default" "test"]}
   :profiles {:1.4 {:dependencies [[org.clojure/clojure "1.4.0"]]}
-             :1.3 {:dependencies [[org.clojure/clojure "1.3.0"]]}})
+             :1.3 {:dependencies [[org.clojure/clojure "1.3.0"]]}}
+  :plugins [[codox "0.8.0"]])