Skip to content

Commit

Permalink
Update docs for latest version.
Browse files Browse the repository at this point in the history
  • Loading branch information
pjstadig committed Jul 16, 2015
1 parent e192a45 commit 86b4cd9
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 21 deletions.
2 changes: 1 addition & 1 deletion latest/index.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><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>Config 0.10.0-SNAPSHOT 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">Config 0.10.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outpace</span></div></div></li><li class="depth-2"><a href="outpace.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3"><a href="outpace.config.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="namespace-index" id="content"><h2>Config 0.10.0-SNAPSHOT</h2><div class="doc"><p>A library for declaring and setting configuration vars.</p></div><div class="namespace"><h3><a href="outpace.config.html">outpace.config</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="outpace.config.html#var--.3EEdnVal">-&gt;EdnVal</a> </li><li> <a href="outpace.config.html#var--.3EEnvVal">-&gt;EnvVal</a> </li><li> <a href="outpace.config.html#var--.3EFileVal">-&gt;FileVal</a> </li><li> <a href="outpace.config.html#var-config">config</a> </li><li> <a href="outpace.config.html#var-defaults">defaults</a> </li><li> <a href="outpace.config.html#var-defconfig">defconfig</a> </li><li> <a href="outpace.config.html#var-defconfig.21">defconfig!</a> </li><li> <a href="outpace.config.html#var-Extractable">Extractable</a> </li><li> <a href="outpace.config.html#var-generating.3F">generating?</a> </li><li> <a href="outpace.config.html#var-load-data-readers">load-data-readers</a> </li><li> <a href="outpace.config.html#var-lookup">lookup</a> </li><li> <a href="outpace.config.html#var-map-.3EEdnVal">map-&gt;EdnVal</a> </li><li> <a href="outpace.config.html#var-map-.3EEnvVal">map-&gt;EnvVal</a> </li><li> <a href="outpace.config.html#var-map-.3EFileVal">map-&gt;FileVal</a> </li><li> <a href="outpace.config.html#var-non-defaulted">non-defaulted</a> </li><li> <a href="outpace.config.html#var-Optional">Optional</a> </li><li> <a href="outpace.config.html#var-present.3F">present?</a> </li><li> <a href="outpace.config.html#var-read-config">read-config</a> </li><li> <a href="outpace.config.html#var-read-edn">read-edn</a> </li><li> <a href="outpace.config.html#var-read-env">read-env</a> </li><li> <a href="outpace.config.html#var-read-file">read-file</a> </li><li> <a href="outpace.config.html#var-unbound">unbound</a> </li><li> <a href="outpace.config.html#var-valid-key.3F">valid-key?</a> </li><li> <a href="outpace.config.html#var-validate">validate</a> </li><li> <a href="outpace.config.html#var-var-symbol">var-symbol</a> </li></ul></div></div><div class="namespace"><h3><a href="outpace.config.bootstrap.html">outpace.config.bootstrap</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="outpace.config.bootstrap.html#var-explicit-config-source">explicit-config-source</a> </li><li> <a href="outpace.config.bootstrap.html#var-find-config-source">find-config-source</a> </li></ul></div></div><div class="namespace"><h3><a href="outpace.config.generate.html">outpace.config.generate</a></h3><div class="doc"><pre class="plaintext">Namespace for generating a config EDN file.
<html><head><meta charset="UTF-8"><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>Config 0.11.0-SNAPSHOT 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">Config 0.11.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outpace</span></div></div></li><li class="depth-2"><a href="outpace.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3"><a href="outpace.config.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="namespace-index" id="content"><h2>Config 0.11.0-SNAPSHOT</h2><div class="doc"><p>A library for declaring and setting configuration vars.</p></div><div class="namespace"><h3><a href="outpace.config.html">outpace.config</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="outpace.config.html#var--.3EEdnVal">-&gt;EdnVal</a> </li><li> <a href="outpace.config.html#var--.3EEnvVal">-&gt;EnvVal</a> </li><li> <a href="outpace.config.html#var--.3EFileVal">-&gt;FileVal</a> </li><li> <a href="outpace.config.html#var--.3EPropVal">-&gt;PropVal</a> </li><li> <a href="outpace.config.html#var-config">config</a> </li><li> <a href="outpace.config.html#var-defaults">defaults</a> </li><li> <a href="outpace.config.html#var-defconfig">defconfig</a> </li><li> <a href="outpace.config.html#var-defconfig.21">defconfig!</a> </li><li> <a href="outpace.config.html#var-Extractable">Extractable</a> </li><li> <a href="outpace.config.html#var-generating.3F">generating?</a> </li><li> <a href="outpace.config.html#var-load-data-readers">load-data-readers</a> </li><li> <a href="outpace.config.html#var-lookup">lookup</a> </li><li> <a href="outpace.config.html#var-map-.3EEdnVal">map-&gt;EdnVal</a> </li><li> <a href="outpace.config.html#var-map-.3EEnvVal">map-&gt;EnvVal</a> </li><li> <a href="outpace.config.html#var-map-.3EFileVal">map-&gt;FileVal</a> </li><li> <a href="outpace.config.html#var-map-.3EPropVal">map-&gt;PropVal</a> </li><li> <a href="outpace.config.html#var-non-defaulted">non-defaulted</a> </li><li> <a href="outpace.config.html#var-Optional">Optional</a> </li><li> <a href="outpace.config.html#var-present.3F">present?</a> </li><li> <a href="outpace.config.html#var-read-config">read-config</a> </li><li> <a href="outpace.config.html#var-read-edn">read-edn</a> </li><li> <a href="outpace.config.html#var-read-env">read-env</a> </li><li> <a href="outpace.config.html#var-read-file">read-file</a> </li><li> <a href="outpace.config.html#var-read-property">read-property</a> </li><li> <a href="outpace.config.html#var-unbound">unbound</a> </li><li> <a href="outpace.config.html#var-valid-key.3F">valid-key?</a> </li><li> <a href="outpace.config.html#var-validate">validate</a> </li><li> <a href="outpace.config.html#var-var-symbol">var-symbol</a> </li></ul></div></div><div class="namespace"><h3><a href="outpace.config.bootstrap.html">outpace.config.bootstrap</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="outpace.config.bootstrap.html#var-explicit-config-source">explicit-config-source</a> </li><li> <a href="outpace.config.bootstrap.html#var-find-config-source">find-config-source</a> </li></ul></div></div><div class="namespace"><h3><a href="outpace.config.generate.html">outpace.config.generate</a></h3><div class="doc"><pre class="plaintext">Namespace for generating a config EDN file.
Example usage:
lein run -m outpace.config.generate :strict</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="outpace.config.generate.html#var--main">-main</a> </li><li> <a href="outpace.config.generate.html#var-pretty-str">pretty-str</a> </li></ul></div></div><div class="namespace"><h3><a href="outpace.config.repl.html">outpace.config.repl</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="outpace.config.repl.html#var-reload">reload</a> </li></ul></div></div></div></body></html>
2 changes: 1 addition & 1 deletion latest/outpace.config.bootstrap.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><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>outpace.config.bootstrap 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">Config 0.10.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outpace</span></div></div></li><li class="depth-2"><a href="outpace.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-3 branch current"><a href="outpace.config.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3"><a href="outpace.config.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="outpace.config.bootstrap.html#var-explicit-config-source"><div class="inner"><span>explicit-config-source</span></div></a></li><li class="depth-1"><a href="outpace.config.bootstrap.html#var-find-config-source"><div class="inner"><span>find-config-source</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">outpace.config.bootstrap</h2><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-explicit-config-source"><h3>explicit-config-source</h3><div class="usage"></div><div class="doc"><pre class="plaintext">When set to a non-nil value, will be used as the config-source.
<html><head><meta charset="UTF-8"><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>outpace.config.bootstrap 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">Config 0.11.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outpace</span></div></div></li><li class="depth-2"><a href="outpace.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-3 branch current"><a href="outpace.config.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3"><a href="outpace.config.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="outpace.config.bootstrap.html#var-explicit-config-source"><div class="inner"><span>explicit-config-source</span></div></a></li><li class="depth-1"><a href="outpace.config.bootstrap.html#var-find-config-source"><div class="inner"><span>find-config-source</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">outpace.config.bootstrap</h2><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-explicit-config-source"><h3>explicit-config-source</h3><div class="usage"></div><div class="doc"><pre class="plaintext">When set to a non-nil value, will be used as the config-source.
The value must be a source acceptable to clojure.java.io/reader.
Note: Code that sets this must do so prior to loading outpace.config
namespace or any namespace that transitively requires outpace.config.</pre></div><div class="src-link"><a href="http://github.com/outpace/config/blob/master/src/outpace/config/bootstrap.clj#L4">view source</a></div></div><div class="public anchor" id="var-find-config-source"><h3>find-config-source</h3><div class="usage"><code>(find-config-source)</code></div><div class="doc"><pre class="plaintext">Returns the first config EDN source found from:
Expand Down
2 changes: 1 addition & 1 deletion latest/outpace.config.generate.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html><head><meta charset="UTF-8"><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>outpace.config.generate 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">Config 0.10.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outpace</span></div></div></li><li class="depth-2"><a href="outpace.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-3 branch current"><a href="outpace.config.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3"><a href="outpace.config.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="outpace.config.generate.html#var--main"><div class="inner"><span>-main</span></div></a></li><li class="depth-1"><a href="outpace.config.generate.html#var-pretty-str"><div class="inner"><span>pretty-str</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">outpace.config.generate</h2><div class="doc"><pre class="plaintext">Namespace for generating a config EDN file.
<html><head><meta charset="UTF-8"><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>outpace.config.generate 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">Config 0.11.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outpace</span></div></div></li><li class="depth-2"><a href="outpace.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-3 branch"><a href="outpace.config.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-3 branch current"><a href="outpace.config.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3"><a href="outpace.config.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="outpace.config.generate.html#var--main"><div class="inner"><span>-main</span></div></a></li><li class="depth-1"><a href="outpace.config.generate.html#var-pretty-str"><div class="inner"><span>pretty-str</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">outpace.config.generate</h2><div class="doc"><pre class="plaintext">Namespace for generating a config EDN file.
Example usage:
lein run -m outpace.config.generate :strict</pre></div><div class="public anchor" id="var--main"><h3>-main</h3><div class="usage"><code>(-main &amp; flags)</code></div><div class="doc"><pre class="plaintext">Generates a config EDN file from the defconfig entries on the classpath.
Writes to the configuration source if provided, otherwise to &apos;config.edn&apos;.
Expand Down
Loading

0 comments on commit 86b4cd9

Please sign in to comment.