Skip to content

Commit dcbc007

Browse files
author
Frazer Irving
committed
auto generated docs
1 parent ea54deb commit dcbc007

9 files changed

+795
-0
lines changed

‎doc/css/default.css

+551
Large diffs are not rendered by default.

‎doc/css/highlight.css

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
/*
2+
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
3+
*/
4+
5+
.hljs {
6+
display: block;
7+
overflow-x: auto;
8+
padding: 0.5em;
9+
color: #333;
10+
background: #f8f8f8;
11+
}
12+
13+
.hljs-comment,
14+
.hljs-quote {
15+
color: #998;
16+
font-style: italic;
17+
}
18+
19+
.hljs-keyword,
20+
.hljs-selector-tag,
21+
.hljs-subst {
22+
color: #333;
23+
font-weight: bold;
24+
}
25+
26+
.hljs-number,
27+
.hljs-literal,
28+
.hljs-variable,
29+
.hljs-template-variable,
30+
.hljs-tag .hljs-attr {
31+
color: #008080;
32+
}
33+
34+
.hljs-string,
35+
.hljs-doctag {
36+
color: #d14;
37+
}
38+
39+
.hljs-title,
40+
.hljs-section,
41+
.hljs-selector-id {
42+
color: #900;
43+
font-weight: bold;
44+
}
45+
46+
.hljs-subst {
47+
font-weight: normal;
48+
}
49+
50+
.hljs-type,
51+
.hljs-class .hljs-title {
52+
color: #458;
53+
font-weight: bold;
54+
}
55+
56+
.hljs-tag,
57+
.hljs-name,
58+
.hljs-attribute {
59+
color: #000080;
60+
font-weight: normal;
61+
}
62+
63+
.hljs-regexp,
64+
.hljs-link {
65+
color: #009926;
66+
}
67+
68+
.hljs-symbol,
69+
.hljs-bullet {
70+
color: #990073;
71+
}
72+
73+
.hljs-built_in,
74+
.hljs-builtin-name {
75+
color: #0086b3;
76+
}
77+
78+
.hljs-meta {
79+
color: #999;
80+
font-weight: bold;
81+
}
82+
83+
.hljs-deletion {
84+
background: #fdd;
85+
}
86+
87+
.hljs-addition {
88+
background: #dfd;
89+
}
90+
91+
.hljs-emphasis {
92+
font-style: italic;
93+
}
94+
95+
.hljs-strong {
96+
font-weight: bold;
97+
}

‎doc/fbia-client.auth.html

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!DOCTYPE html PUBLIC ""
2+
"">
3+
<html><head><meta charset="UTF-8" /><title>fbia-client.auth documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Fbia-client</span> <span class="project-version">0.4.6-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></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>fbia-client</span></div></div></li><li class="depth-2 branch current"><a href="fbia-client.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-2 branch"><a href="fbia-client.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2"><a href="fbia-client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="fbia-client.auth.html#var-accounts"><div class="inner"><span>accounts</span></div></a></li><li class="depth-1"><a href="fbia-client.auth.html#var-extend-token"><div class="inner"><span>extend-token</span></div></a></li><li class="depth-1"><a href="fbia-client.auth.html#var-page-token-from-user-token"><div class="inner"><span>page-token-from-user-token</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">fbia-client.auth</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-accounts"><h3>accounts</h3><div class="usage"><code>(accounts extended-token)</code></div><div class="doc"><pre class="plaintext">Loads the accounts page at /me/accounts
4+
</pre></div></div><div class="public anchor" id="var-extend-token"><h3>extend-token</h3><div class="usage"><code>(extend-token app-id app-secret short-lived-token)</code></div><div class="doc"><pre class="plaintext">Given a short-lived user token, generates a long-lived user token
5+
</pre></div></div><div class="public anchor" id="var-page-token-from-user-token"><h3>page-token-from-user-token</h3><div class="usage"><code>(page-token-from-user-token page-id app-id app-secret user-token)</code></div><div class="doc"><pre class="plaintext"></pre></div></div></div></body></html>

‎doc/fbia-client.core.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<!DOCTYPE html PUBLIC ""
2+
"">
3+
<html><head><meta charset="UTF-8" /><title>fbia-client.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Fbia-client</span> <span class="project-version">0.4.6-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></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>fbia-client</span></div></div></li><li class="depth-2 branch"><a href="fbia-client.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-2 branch current"><a href="fbia-client.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2"><a href="fbia-client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="fbia-client.core.html#var-create-article"><div class="inner"><span>create-article</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-delete-article"><div class="inner"><span>delete-article</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-delete-article-multi"><div class="inner"><span>delete-article-multi</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-get-article"><div class="inner"><span>get-article</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-import-status"><div class="inner"><span>import-status</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-list-articles"><div class="inner"><span>list-articles</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-lookup-article"><div class="inner"><span>lookup-article</span></div></a></li><li class="depth-1"><a href="fbia-client.core.html#var-lookup-article-multi"><div class="inner"><span>lookup-article-multi</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">fbia-client.core</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-create-article"><h3>create-article</h3><div class="usage"><code>(create-article page-id {:keys [html_source access_token], :as params})</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-delete-article"><h3>delete-article</h3><div class="usage"><code>(delete-article article-id {:keys [access_token], :as params})</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-delete-article-multi"><h3>delete-article-multi</h3><div class="usage"><code>(delete-article-multi {:keys [access_token fields ids], :as params})</code></div><div class="doc"><pre class="plaintext">Retrieve a specific instant article by canonical URL
4+
</pre></div></div><div class="public anchor" id="var-get-article"><h3>get-article</h3><div class="usage"><code>(get-article id {:keys [access_token], :as params})</code></div><div class="doc"><pre class="plaintext">Retrieve a specific instant article by instant article id
5+
</pre></div></div><div class="public anchor" id="var-import-status"><h3>import-status</h3><div class="usage"><code>(import-status import-status-id {:keys [access_token], :as params})</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-list-articles"><h3>list-articles</h3><div class="usage"><code>(list-articles page-id {:keys [access_token], :as params})</code></div><div class="doc"><pre class="plaintext">Retrieve a list of instant articles for a page
6+
</pre></div></div><div class="public anchor" id="var-lookup-article"><h3>lookup-article</h3><div class="usage"><code>(lookup-article {:keys [access_token fields id], :as params})</code></div><div class="doc"><pre class="plaintext">Retrieve a specific instant article by canonical URL
7+
</pre></div></div><div class="public anchor" id="var-lookup-article-multi"><h3>lookup-article-multi</h3><div class="usage"><code>(lookup-article-multi {:keys [access_token fields ids], :as params})</code></div><div class="doc"><pre class="plaintext">Retrieve a specific instant article by canonical URL
8+
</pre></div></div></div></body></html>

‎doc/fbia-client.util.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!DOCTYPE html PUBLIC ""
2+
"">
3+
<html><head><meta charset="UTF-8" /><title>fbia-client.util documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Fbia-client</span> <span class="project-version">0.4.6-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></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>fbia-client</span></div></div></li><li class="depth-2 branch"><a href="fbia-client.auth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auth</span></div></a></li><li class="depth-2 branch"><a href="fbia-client.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 current"><a href="fbia-client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="fbia-client.util.html#var-aform"><div class="inner"><span>aform</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-delete-request"><div class="inner"><span>delete-request</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-error-message"><div class="inner"><span>error-message</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-get-request"><div class="inner"><span>get-request</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-graph-url"><div class="inner"><span>graph-url</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-ncpus"><div class="inner"><span>ncpus</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-parallelism"><div class="inner"><span>parallelism</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-post-request"><div class="inner"><span>post-request</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-xf-http-decode"><div class="inner"><span>xf-http-decode</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-xf-http-response"><div class="inner"><span>xf-http-response</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-xf-json-decode"><div class="inner"><span>xf-json-decode</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-xform-filter"><div class="inner"><span>xform-filter</span></div></a></li><li class="depth-1"><a href="fbia-client.util.html#var-xform-map"><div class="inner"><span>xform-map</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">fbia-client.util</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-aform"><h3>aform</h3><div class="usage"><code>(aform f)</code></div><div class="doc"><pre class="plaintext">async fn (see pipeline-async) that catches exceptions and passes through throwables
4+
</pre></div></div><div class="public anchor" id="var-delete-request"><h3>delete-request</h3><div class="usage"><code>(delete-request url)</code></div><div class="doc"><pre class="plaintext">Makes DELETE HTTP request, Returns a channel with one message, either an error (Throwable) or body
5+
</pre></div></div><div class="public anchor" id="var-error-message"><h3>error-message</h3><div class="usage"><code>(error-message e)</code></div><div class="doc"><pre class="plaintext">the errors are nested so far down in the responses, so so far down
6+
</pre></div></div><div class="public anchor" id="var-get-request"><h3>get-request</h3><div class="usage"><code>(get-request url)</code></div><div class="doc"><pre class="plaintext">Makes GET HTTP request, Returns a channel with one message, either an error (Throwable) or body
7+
</pre></div></div><div class="public anchor" id="var-graph-url"><h3>graph-url</h3><div class="usage"><code>(graph-url path params)</code><code>(graph-url version path params)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-ncpus"><h3>ncpus</h3><div class="usage"><code>(ncpus)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-parallelism"><h3>parallelism</h3><div class="usage"><code>(parallelism)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-post-request"><h3>post-request</h3><div class="usage"><code>(post-request url &amp; [params])</code></div><div class="doc"><pre class="plaintext">Makes POST HTTP request, Returns a channel with one message, either an error (Throwable) or body
8+
</pre></div></div><div class="public anchor" id="var-xf-http-decode"><h3>xf-http-decode</h3><div class="usage"></div><div class="doc"><pre class="plaintext">transducer to handle HTTP query string decoding
9+
</pre></div></div><div class="public anchor" id="var-xf-http-response"><h3>xf-http-response</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Transducer to handle http responses
10+
</pre></div></div><div class="public anchor" id="var-xf-json-decode"><h3>xf-json-decode</h3><div class="usage"></div><div class="doc"><pre class="plaintext">Transducer to handle JSON decoding
11+
</pre></div></div><div class="public anchor" id="var-xform-filter"><h3>xform-filter</h3><div class="usage"><code>(xform-filter f)</code></div><div class="doc"><pre class="plaintext">filter transducer that catches exceptions and passes through throwables
12+
</pre></div></div><div class="public anchor" id="var-xform-map"><h3>xform-map</h3><div class="usage"><code>(xform-map f)</code></div><div class="doc"><pre class="plaintext">map transducer that catches exceptions and passes through throwables
13+
</pre></div></div></div></body></html>

0 commit comments

Comments
 (0)