Skip to content
This repository was archived by the owner on Nov 20, 2020. It is now read-only.

Commit 614f567

Browse files
committed
feat(docs): change structure
1 parent 466c465 commit 614f567

File tree

10 files changed

+6
-5
lines changed

10 files changed

+6
-5
lines changed

docs/ApolloHooks/index.html docs/ReasonApolloHooks/ApolloHooks/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,5 +108,5 @@
108108
})
109109
}
110110

111-
<button>{React.string("Click me")}</button>
111+
<button onClick>{React.string("Click me")}</button>
112112
}</code></pre></dd></dl><dl><dt class="spec value" id="val-useSubscription"><a href="#val-useSubscription" class="anchor"></a><code><span class="keyword">let</span> useSubscription: ?&#8288;variables:Js.Json.t <span>=&gt;</span> ?&#8288;client:ApolloClient.generatedApolloClient <span>=&gt;</span> <a href="../ApolloHooksTypes#type-graphqlDefinition">ApolloHooksTypes.graphqlDefinition</a>(<span class="type-var">'a</span><span class="type-var">'b</span><span class="type-var">'c</span>) <span>=&gt;</span> (<a href="../ApolloHooksSubscription#type-variant">Subscription.variant</a>(<span class="type-var">'a</span>), <a href="../ApolloHooksSubscription#type-result">Subscription.result</a>(<span class="type-var">'a</span>));</code></dt><dd><p>useSubscription bindings</p></dd></dl><dl><dt class="spec value" id="val-toQueryObj"><a href="#val-toQueryObj" class="anchor"></a><code><span class="keyword">let</span> toQueryObj: Js.t({.. query: string, variables: Js.Json.t, }) <span>=&gt;</span> ApolloClient.queryObj;</code></dt><dd><p>Helper to generate the shape of a query for <code>refetchQueries</code> mutation param. Take a look in examples/persons/src/EditPerson.re for a more complete demo of usage.</p></dd></dl><dl><dt class="spec value" id="val-toReadQueryOptions"><a href="#val-toReadQueryOptions" class="anchor"></a><code><span class="keyword">let</span> toReadQueryOptions: Js.t({.. query: string, variables: <span class="type-var">'a</span>, }) <span>=&gt;</span> Js.t({. query: ReasonApolloTypes.queryString, variables: Js.Nullable.t(<span class="type-var">'a</span>), });</code></dt><dd><p>Helper to generate the shape of a query for <code>ApolloClient.ReadQuery.readQuery</code>. Used for optimistic UI. Take a look in examples/persons/src/FilterByNameCache.re for a more complete demo of usage.</p></dd></dl></div></body></html>

docs/ReasonApolloHooks/index.html

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ReasonApolloHooks.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../">Up</a> – ReasonApolloHooks</nav></header><h3 id="top"><a href="#top" class="anchor"></a>Index</h3><p>Hello!</p><p>Check out the module <a href="ApolloHooks"><code>ApolloHooks</code></a> to get started.</p></div></body></html>

docs/index.html

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
<!DOCTYPE html>
2-
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ReasonApolloHooks.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../">Up</a> – ReasonApolloHooks</nav></header><h3 id="top"><a href="#top" class="anchor"></a>Index</h3><p>Hello!</p><p>Check out the module <a href="ApolloHooks"><code>ApolloHooks</code></a> to get started.</p></div></body></html>
1+
<meta http-equiv="refresh" content="0;URL='./ReasonApolloHooks/ApolloHooks'" />

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"start": "bsb -make-world -w",
77
"clean": "bsb -clean-world",
88
"test": "echo \"Error: no test specified\" && exit 1",
9-
"build:docs": "yarn build && rm -rf docs/ && bsdoc support-files && bsdoc build --debug --verbose ReasonApolloHooks && mv docs/ReasonApolloHooks/* docs/"
9+
"build:docs": "yarn build && bsdoc build --debug --verbose ReasonApolloHooks"
1010
},
1111
"keywords": [
1212
"BuckleScript"

src/index.mld

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
Hello!
44

5-
Check out the module {!ApolloHooks} to get started.
5+
Check out the module {!module:ApolloHooks} to get started.

0 commit comments

Comments
 (0)