Initial gh-pages commit (v1.2.0)

This commit is contained in:
Peter Taoussanis 2013-06-01 19:16:45 +07:00
commit 3e6b2dbc5c
8 changed files with 319 additions and 0 deletions

13
.gitignore vendored Normal file
View file

@ -0,0 +1,13 @@
/target
/lib
/classes
/checkouts
/logs
/docs
/doc
pom.xml
*.jar
*.class
*.sh
.lein*
.env

210
css/default.css Normal file
View file

@ -0,0 +1,210 @@
body {
font-family: sans-serif;
font-size: 11pt;
}
pre, code {
font-family: Monaco, DejaVu Sans Mono, Consolas, monospace;
font-size: 9pt;
}
h2 {
font-weight: normal;
font-size: 18pt;
margin: 10px 0 0.4em 0;
}
#header, #content, .sidebar {
position: fixed;
}
#header {
top: 0;
left: 0;
right: 0;
height: 20px;
background: #444;
color: #fff;
padding: 5px;
}
#content {
top: 30px;
right: 0;
bottom: 0;
overflow: auto;
background: #fff;
color: #333;
padding: 0 1em;
}
.sidebar {
position: fixed;
top: 30px;
bottom: 0;
overflow: auto;
}
#namespaces {
background: #e6e6e6;
border-right: solid 1px #bbb;
left: 0;
width: 250px;
}
#vars {
background: #eeeeee;
border-right: solid 1px #ccc;
left: 251px;
width: 200px;
}
.namespace-index {
left: 251px;
}
.namespace-docs {
left: 452px;
}
#header {
background: -moz-linear-gradient(top, #555 0%, #222 100%);
background: -webkit-linear-gradient(top, #555 0%, #333 100%);
background: -o-linear-gradient(top, #555 0%, #222 100%);
background: -ms-linear-gradient(top, #555 0%, #222 100%);
background: linear-gradient(top, #555 0%, #222 100%);
box-shadow: 0 0 10px #555;
z-index: 100;
}
#header h1 {
margin: 0;
padding: 0;
font-size: 12pt;
font-weight: normal;
text-shadow: -1px -1px 0px #333;
}
#header a, .sidebar a {
display: block;
text-decoration: none;
}
#header a {
color: #fff;
}
.sidebar a {
color: #333;
}
#header h2 {
float: right;
font-size: 9pt;
font-weight: normal;
width: 10em;
margin: 3px 0;
color: #bbb;
}
#header h2 a {
display: inline;
}
.sidebar h3 {
margin: 0;
padding: 10px 0.5em 0 0.5em;
font-size: 14pt;
font-weight: normal
}
.sidebar ul {
padding: 0.5em 0em;
margin: 0;
}
.sidebar li {
display: block;
}
.sidebar li a {
padding: 7px 10px;
}
#namespaces li.current a {
border-left: 3px solid #a33;
padding-left: 7px;
color: #a33;
}
#vars li.current a {
border-left: 3px solid #33a;
padding-left: 7px;
color: #33a;
}
#content h3 {
margin-bottom: 0.5em;
font-size: 13pt;
font-weight: bold;
}
.public h3, h4.macro {
margin: 0;
float: left;
}
.usage {
clear: both;
}
h4.macro {
font-variant: small-caps;
font-size: 13px;
font-weight: bold;
color: #717171;
margin-top: 3px;
margin-left: 10px;
}
.public {
margin-top: 1.5em;
margin-bottom: 2.0em;
}
.public:last-child {
margin-bottom: 20%;
}
.namespace:last-child {
margin-bottom: 10%;
}
.index {
padding: 0;
}
.index * {
display: inline;
}
.index li {
padding: 0 .5em;
}
.index ul {
padding-left: 0;
}
.usage code {
display: block;
color: #008;
}
.doc {
margin-bottom: .5em;
}
.src-link a {
font-size: 9pt;
}

3
index.html Normal file
View file

@ -0,0 +1,3 @@
<!DOCTYPE html>
<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>Nippy 1.2.0 API documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 1.2.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="namespace-index" id="content"><h2>Nippy 1.2.0 API documentation</h2><div class="doc">Clojure serialization library</div><div class="namespace"><h3><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></h3><pre class="doc">Simple, high-performance Clojure serialization library. Adapted from
Deep-Freeze.</pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.html#var-coll-freezer"><span>coll-freezer</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw%21"><span>coll-thaw!</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw-kvs%21"><span>coll-thaw-kvs!</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-stream%21"><span>freeze-to-stream!</span></a></li><li><a href="taoensso.nippy.html#var-freezer"><span>freezer</span></a></li><li><a href="taoensso.nippy.html#var-kv-freezer"><span>kv-freezer</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-stream%21"><span>thaw-from-stream!</span></a></li></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></h3><pre class="doc"></pre><div class="index"><p>Public variables and functions:</p><ul><li><a href="taoensso.nippy.utils.html#var-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-case-eval"><span>case-eval</span></a></li><li><a href="taoensso.nippy.utils.html#var-pairs"><span>pairs</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</span></a></li><li><a href="taoensso.nippy.utils.html#var-version-compare"><span>version-compare</span></a></li></ul></div></div></div></body></html>

4
js/jquery.min.js vendored Normal file

File diff suppressed because one or more lines are too long

67
js/page_effects.js Normal file
View file

@ -0,0 +1,67 @@
function visibleInParent(element) {
var position = $(element).position().top
return position > -50 && position < ($(element).offsetParent().height() - 50)
}
function hasFragment(link, fragment) {
return $(link).attr("href").indexOf("#" + fragment) != -1
}
function findLinkByFragment(elements, fragment) {
return $(elements).filter(function(i, e) { return hasFragment(e, fragment)}).first()
}
function setCurrentVarLink() {
$('#vars li').removeClass('current')
$('.public').
filter(function(index) { return visibleInParent(this) }).
each(function(index, element) {
findLinkByFragment("#vars a", element.id).
parent().
addClass('current')
})
}
var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }())
function scrollPositionId(element) {
var directory = window.location.href.replace(/[^\/]+\.html$/, '')
return 'scroll::' + $(element).attr('id') + '::' + directory
}
function storeScrollPosition(element) {
if (!hasStorage) return;
localStorage.setItem(scrollPositionId(element) + "::x", $(element).scrollLeft())
localStorage.setItem(scrollPositionId(element) + "::y", $(element).scrollTop())
}
function recallScrollPosition(element) {
if (!hasStorage) return;
$(element).scrollLeft(localStorage.getItem(scrollPositionId(element) + "::x"))
$(element).scrollTop(localStorage.getItem(scrollPositionId(element) + "::y"))
}
function persistScrollPosition(element) {
recallScrollPosition(element)
$(element).scroll(function() { storeScrollPosition(element) })
}
function sidebarContentWidth(element) {
var widths = $(element).find('span').map(function() { return $(this).width() })
return Math.max.apply(Math, widths)
}
function resizeNamespaces() {
var width = sidebarContentWidth('#namespaces') + 40
$('#namespaces').css('width', width)
$('#vars, .namespace-index').css('left', width + 1)
$('.namespace-docs').css('left', $('#vars').width() + width + 2)
}
$(window).ready(resizeNamespaces)
$(window).ready(setCurrentVarLink)
$(window).ready(function() { persistScrollPosition('#namespaces')})
$(window).ready(function() {
$('#content').scroll(setCurrentVarLink)
$(window).resize(setCurrentVarLink)
})

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.benchmarks documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 1.2.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li class="current"><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.benchmarks documentation</h2><pre class="doc"></pre></div></body></html>

13
taoensso.nippy.html Normal file
View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 1.2.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li class="current"><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.html#var-coll-freezer"><span>coll-freezer</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw%21"><span>coll-thaw!</span></a></li><li><a href="taoensso.nippy.html#var-coll-thaw-kvs%21"><span>coll-thaw-kvs!</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-bytes"><span>freeze-to-bytes</span></a></li><li><a href="taoensso.nippy.html#var-freeze-to-stream%21"><span>freeze-to-stream!</span></a></li><li><a href="taoensso.nippy.html#var-freezer"><span>freezer</span></a></li><li><a href="taoensso.nippy.html#var-kv-freezer"><span>kv-freezer</span></a></li><li><a href="taoensso.nippy.html#var-stress-data"><span>stress-data</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-bytes"><span>thaw-from-bytes</span></a></li><li><a href="taoensso.nippy.html#var-thaw-from-stream%21"><span>thaw-from-stream!</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy documentation</h2><pre class="doc">Simple, high-performance Clojure serialization library. Adapted from
Deep-Freeze.</pre><div class="public" id="var-coll-freezer"><h3>coll-freezer</h3><h4 class="macro">macro</h4><div class="usage"><code>(coll-freezer type id &amp; body)</code></div><pre class="doc">Extends Freezable to simple collection types.
</pre></div><div class="public" id="var-coll-thaw%21"><h3>coll-thaw!</h3><div class="usage"><code>(coll-thaw! s)</code></div><pre class="doc">Thaws simple collection types.
</pre></div><div class="public" id="var-coll-thaw-kvs%21"><h3>coll-thaw-kvs!</h3><div class="usage"><code>(coll-thaw-kvs! s)</code></div><pre class="doc">Thaws key-value collection types.
</pre></div><div class="public" id="var-freeze-to-bytes"><h3>freeze-to-bytes</h3><div class="usage"><code>(freeze-to-bytes x &amp; {:keys [compress? print-dup?], :or {compress? true, print-dup? true}})</code></div><pre class="doc">Serializes x to a byte array and returns the array.
</pre></div><div class="public" id="var-freeze-to-stream%21"><h3>freeze-to-stream!</h3><div class="usage"><code>(freeze-to-stream! data-output-stream x)</code><code>(freeze-to-stream! data-output-stream x print-dup?)</code></div><pre class="doc">Serializes x to given output stream.
</pre></div><div class="public" id="var-freezer"><h3>freezer</h3><h4 class="macro">macro</h4><div class="usage"><code>(freezer type id &amp; body)</code></div><pre class="doc">Helper to extend Freezable protocol.
</pre></div><div class="public" id="var-kv-freezer"><h3>kv-freezer</h3><h4 class="macro">macro</h4><div class="usage"><code>(kv-freezer type id &amp; body)</code></div><pre class="doc">Extends Freezable to key-value collection types.
</pre></div><div class="public" id="var-stress-data"><h3>stress-data</h3><div class="usage"></div><pre class="doc">Reference data used for tests &amp; benchmarks.
</pre></div><div class="public" id="var-thaw-from-bytes"><h3>thaw-from-bytes</h3><div class="usage"><code>(thaw-from-bytes ba &amp; {:keys [read-eval? compressed?], :or {read-eval? false, compressed? true}})</code></div><pre class="doc">Deserializes an object from given byte array.
</pre></div><div class="public" id="var-thaw-from-stream%21"><h3>thaw-from-stream!</h3><div class="usage"><code>(thaw-from-stream! data-input-stream read-eval?)</code></div><pre class="doc">Deserializes an object from given input stream.
</pre></div></div></body></html>

View file

@ -0,0 +1,7 @@
<!DOCTYPE html>
<html><head><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>taoensso.nippy.utils documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Nippy 1.2.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><a href="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li class="current"><a href="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="taoensso.nippy.utils.html#var-bench"><span>bench</span></a></li><li><a href="taoensso.nippy.utils.html#var-case-eval"><span>case-eval</span></a></li><li><a href="taoensso.nippy.utils.html#var-pairs"><span>pairs</span></a></li><li><a href="taoensso.nippy.utils.html#var-time-ns"><span>time-ns</span></a></li><li><a href="taoensso.nippy.utils.html#var-version-compare"><span>version-compare</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>taoensso.nippy.utils documentation</h2><pre class="doc"></pre><div class="public" id="var-bench"><h3>bench</h3><h4 class="macro">macro</h4><div class="usage"><code>(bench num-laps form &amp; {:keys [warmup-laps num-threads as-ms?], :or {as-ms? true}})</code></div><pre class="doc">Repeatedly executes form and returns time taken to complete execution.
</pre></div><div class="public" id="var-case-eval"><h3>case-eval</h3><h4 class="macro">macro</h4><div class="usage"><code>(case-eval e &amp; clauses)</code></div><pre class="doc">Like `case` but evaluates test constants for their compile-time value.
</pre></div><div class="public" id="var-pairs"><h3>pairs</h3><div class="usage"><code>(pairs coll)</code></div><pre class="doc">Like (partition 2 coll) but faster and returns lazy seq of vector pairs.
</pre></div><div class="public" id="var-time-ns"><h3>time-ns</h3><h4 class="macro">macro</h4><div class="usage"><code>(time-ns &amp; body)</code></div><pre class="doc">Returns number of nanoseconds it takes to execute body.
</pre></div><div class="public" id="var-version-compare"><h3>version-compare</h3><div class="usage"><code>(version-compare x y)</code></div><pre class="doc">Comparator for version strings like x.y.z, etc.
</pre></div></div></body></html>