updaet doc for 0.2

This commit is contained in:
Simon Cruanes 2023-06-01 16:02:34 -04:00
parent 5307cb7a96
commit ffc46d756d
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
33 changed files with 729 additions and 240 deletions

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl-lwt.index)</title><link rel="stylesheet" href="../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> ezcurl-lwt</nav><header class="odoc-preamble"><h1 id="ezcurl-lwt-index"><a href="#ezcurl-lwt-index" class="anchor"></a>ezcurl-lwt index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl-lwt">Library ezcurl-lwt</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl-lwt"><a href="#library-ezcurl-lwt" class="anchor"></a>Library ezcurl-lwt</h2><p>The entry point of this library is the module: <a href="Ezcurl_lwt/index.html"><code>Ezcurl_lwt</code></a>.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl-lwt.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> ezcurl-lwt</nav><header class="odoc-preamble"><h1 id="ezcurl-lwt-index"><a href="#ezcurl-lwt-index" class="anchor"></a>ezcurl-lwt index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl-lwt">Library ezcurl-lwt</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl-lwt"><a href="#library-ezcurl-lwt" class="anchor"></a>Library ezcurl-lwt</h2><p>The entry point of this library is the module: <a href="Ezcurl_lwt/index.html"><code>Ezcurl_lwt</code></a>.</p></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (ezcurl.Ezcurl_core.Config)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Config</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Config</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-verbose"><a href="#val-verbose" class="anchor"></a><code><span><span class="keyword">val</span> verbose : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-authmethod"><a href="#val-authmethod" class="anchor"></a><code><span><span class="keyword">val</span> authmethod : <span><span><span class="xref-unresolved">Curl</span>.curlAuth list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span><span class="keyword">val</span> max_redirects : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span><span class="keyword">val</span> follow_location : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-username"><a href="#val-username" class="anchor"></a><code><span><span class="keyword">val</span> username : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-password"><a href="#val-password" class="anchor"></a><code><span><span class="keyword">val</span> password : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config (ezcurl.Ezcurl_core.Config)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Config</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Config</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-verbose"><a href="#val-verbose" class="anchor"></a><code><span><span class="keyword">val</span> verbose : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-authmethod"><a href="#val-authmethod" class="anchor"></a><code><span><span class="keyword">val</span> authmethod : <span><span><span class="xref-unresolved">Curl</span>.curlAuth list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_redirects"><a href="#val-max_redirects" class="anchor"></a><code><span><span class="keyword">val</span> max_redirects : <span>int <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-follow_location"><a href="#val-follow_location" class="anchor"></a><code><span><span class="keyword">val</span> follow_location : <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-username"><a href="#val-username" class="anchor"></a><code><span><span class="keyword">val</span> username : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-password"><a href="#val-password" class="anchor"></a><code><span><span class="keyword">val</span> password : <span>string <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div></div></body></html>

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.Make.IO)</title><link rel="stylesheet" href="../../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">ezcurl</a> &#x00BB; <a href="../../index.html">Ezcurl_core</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.IO</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.Make.IO)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">ezcurl</a> &#x00BB; <a href="../../index.html">Ezcurl_core</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.IO</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html>

View file

@ -1,5 +1,5 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (ezcurl.Ezcurl_core.Make)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IO"><a href="#argument-1-IO" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IO/index.html">IO</a></span><span> : <a href="../module-type-IO/index.html">IO</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-io"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span><span> = <span><span class="type-var">'a</span> <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http : <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (ezcurl.Ezcurl_core.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Ezcurl_core.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-IO"><a href="#argument-1-IO" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-IO/index.html">IO</a></span><span> : <a href="../module-type-IO/index.html">IO</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-io"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span><span> = <span><span class="type-var">'a</span> <a href="argument-1-IO/index.html#type-t">IO.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.IO)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.IO</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#underlying-io-monad">Underlying IO Monad</a></li></ul></nav><div class="odoc-content"><h3 id="underlying-io-monad"><a href="#underlying-io-monad" class="anchor"></a>Underlying IO Monad</h3><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (ezcurl.Ezcurl_core.IO)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.IO</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#underlying-io-monad">Underlying IO Monad</a></li></ul></nav><div class="odoc-content"><h3 id="underlying-io-monad"><a href="#underlying-io-monad" class="anchor"></a>Underlying IO Monad</h3><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-return"><a href="#val-return" class="anchor"></a><code><span><span class="keyword">val</span> return : <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;&gt;=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span><span class="keyword">val</span> (&gt;|=) : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'b</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'b</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fail"><a href="#val-fail" class="anchor"></a><code><span><span class="keyword">val</span> fail : <span>exn <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-perform"><a href="#val-perform" class="anchor"></a><code><span><span class="keyword">val</span> perform : <span><span class="xref-unresolved">Curl</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Curl</span>.curlCode <a href="#type-t">t</a></span></span></code></div></div></div></body></html>

View file

@ -1,5 +1,5 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl_core.S)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.S</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#main-signature">Main Signature</a></li></ul></nav><div class="odoc-content"><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3><div class="odoc-spec"><div class="spec type anchored" id="type-io"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http : <html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (ezcurl.Ezcurl_core.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">ezcurl</a> &#x00BB; <a href="../index.html">Ezcurl_core</a> &#x00BB; S</nav><header class="odoc-preamble"><h1>Module type <code><span>Ezcurl_core.S</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#main-signature">Main Signature</a></li></ul></nav><div class="odoc-content"><h3 id="main-signature"><a href="#main-signature" class="anchor"></a>Main Signature</h3><div class="odoc-spec"><div class="spec type anchored" id="type-io"><a href="#type-io" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a io</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-http"><a href="#val-http" class="anchor"></a><code><span><span class="keyword">val</span> http :
<span>?tries:int <span class="arrow">&#45;&gt;</span></span> <span>?tries:int <span class="arrow">&#45;&gt;</span></span>
<span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>?client:<a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span> <span>?config:<a href="../Config/index.html#type-t">Config.t</a> <span class="arrow">&#45;&gt;</span></span>

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl.index)</title><link rel="stylesheet" href="../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../_odoc_support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> ezcurl</nav><header class="odoc-preamble"><h1 id="ezcurl-index"><a href="#ezcurl-index" class="anchor"></a>ezcurl index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl">Library ezcurl</a></li><li><a href="#library-ezcurl.core">Library ezcurl.core</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl"><a href="#library-ezcurl" class="anchor"></a>Library ezcurl</h2><p>The entry point of this library is the module: <a href="Ezcurl/index.html"><code>Ezcurl</code></a>.</p><h2 id="library-ezcurl.core"><a href="#library-ezcurl.core" class="anchor"></a>Library ezcurl.core</h2><p>The entry point of this library is the module: <a href="Ezcurl_core/index.html"><code>Ezcurl_core</code></a>.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ezcurl.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> ezcurl</nav><header class="odoc-preamble"><h1 id="ezcurl-index"><a href="#ezcurl-index" class="anchor"></a>ezcurl index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-ezcurl">Library ezcurl</a></li><li><a href="#library-ezcurl.core">Library ezcurl.core</a></li></ul></nav><div class="odoc-content"><h2 id="library-ezcurl"><a href="#library-ezcurl" class="anchor"></a>Library ezcurl</h2><p>The entry point of this library is the module: <a href="Ezcurl/index.html"><code>Ezcurl</code></a>.</p><h2 id="library-ezcurl.core"><a href="#library-ezcurl.core" class="anchor"></a>Library ezcurl.core</h2><p>The entry point of this library is the module: <a href="Ezcurl_core/index.html"><code>Ezcurl_core</code></a>.</p></div></body></html>

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because one or more lines are too long

View file

@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>index</title> <title>index</title>
<link rel="stylesheet" href="./_odoc_support/odoc.css"/> <link rel="stylesheet" href="./odoc.css"/>
<meta charset="utf-8"/> <meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/> <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head> </head>

View file

@ -1,27 +1,134 @@
@charset "UTF-8"; @charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved. /* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. Distributed under the ISC license, see terms at the end of the file.
odoc 1.5.1 */ odoc 2.2.0 */
/* Fonts */ /* Fonts */
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500'); @import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500');
@import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700'); @import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700');
@import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i'); @import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i');
:root,
.light:root {
--main-background: #FFFFFF;
--color: #333333;
--link-color: #2C94BD;
--anchor-hover: #555;
--anchor-color: #d5d5d5;
--xref-shadow: #cc6666;
--header-shadow: #ddd;
--by-name-version-color: #aaa;
--by-name-nav-link-color: #222;
--target-background: rgba(187, 239, 253, 0.3);
--target-shadow: rgba(187, 239, 253, 0.8);
--pre-border-color: #eee;
--code-background: #f6f8fa;
--li-code-background: #f6f8fa;
--li-code-color: #0d2b3e;
--toc-color: #1F2D3D;
--toc-before-color: #777;
--toc-background: #f6f8fa;
--toc-list-border: #ccc;
--spec-summary-border-color: #5c9cf5;
--spec-summary-background: var(--code-background);
--spec-summary-hover-background: #ebeff2;
--spec-details-after-background: rgba(0, 4, 15, 0.05);
--spec-details-after-shadow: rgba(204, 204, 204, 0.53);
}
.dark:root {
--main-background: #202020;
--code-background: #222;
--line-numbers-background: rgba(0, 0, 0, 0.125);
--navbar-background: #202020;
--color: #bebebe;
--dirname-color: #666;
--underline-color: #444;
--visited-color: #002800;
--visited-number-color: #252;
--unvisited-color: #380000;
--unvisited-number-color: #622;
--somevisited-color: #303000;
--highlight-color: #303e3f;
--line-number-color: rgba(230, 230, 230, 0.3);
--unvisited-margin-color: #622;
--border: #333;
--navbar-border: #333;
--code-color: #ccc;
--li-code-background: #373737;
--li-code-color: #999;
--toc-color: #777;
--toc-background: #252525;
--hljs-link: #999;
--hljs-keyword: #cda869;
--hljs-regexp: #f9ee98;
--hljs-title: #dcdcaa;
--hljs-type: #ac885b;
--hljs-meta: #82aaff;
--hljs-variable: #cf6a4c;
}
@media (prefers-color-scheme: dark) {
:root {
--main-background: #202020;
--code-background: #333;
--line-numbers-background: rgba(0, 0, 0, 0.125);
--navbar-background: #202020;
--meter-unvisited-color: #622;
--meter-visited-color: #252;
--meter-separator-color: black;
--color: #bebebe;
--dirname-color: #666;
--underline-color: #444;
--visited-color: #002800;
--visited-number-color: #252;
--unvisited-color: #380000;
--unvisited-number-color: #622;
--somevisited-color: #303000;
--highlight-color: #303e3f;
--line-number-color: rgba(230, 230, 230, 0.3);
--unvisited-margin-color: #622;
--border: #333;
--navbar-border: #333;
--code-color: #ccc;
--by-name-nav-link-color: var(--color);
--li-code-background: #373737;
--li-code-color: #999;
--toc-color: #777;
--toc-before-color: #777;
--toc-background: #252525;
--toc-list-border: #ccc;
--spec-summary-hover-background: #ebeff2;
--spec-details-after-background: rgba(0, 4, 15, 0.05);
--spec-details-after-shadow: rgba(204, 204, 204, 0.53);
--hljs-link: #999;
--hljs-keyword: #cda869;
--hljs-regexp: #f9ee98;
--hljs-title: #dcdcaa;
--hljs-type: #ac885b;
--hljs-meta: #82aaff;
--hljs-variable: #cf6a4c;
}
}
/* Reset a few things. */ /* Reset a few things. */
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video { html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0; padding: 0;
border: 0; border: 0;
font-size: inherit;
font: inherit; font: inherit;
line-height: inherit;
vertical-align: baseline; vertical-align: baseline;
text-align: inherit;
color: inherit;
background: transparent;
} }
table { table {
@ -38,14 +145,14 @@ html {
} }
body { body {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
text-align: left; text-align: left;
color: #333;
background: #FFFFFF; background: #FFFFFF;
color: var(--color);
background-color: var(--main-background);
} }
.content { body {
max-width: 90ex; max-width: 100ex;
margin-left: calc(10vw + 20ex); margin-left: calc(10vw + 20ex);
margin-right: 4ex; margin-right: 4ex;
margin-top: 20px; margin-top: 20px;
@ -54,24 +161,32 @@ body {
line-height: 1.5; line-height: 1.5;
} }
.content>header { header {
margin-bottom: 30px; margin-bottom: 30px;
} }
.content>header nav { nav {
font-family: "Fira Sans", Helvetica, Arial, sans-serif; font-family: "Fira Sans", Helvetica, Arial, sans-serif;
} }
/* Basic markup elements */ /* Basic markup elements */
b, strong { b, strong {
font-weight: 500; font-weight: bold;
} }
i, em { i {
font-style: italic; font-style: italic;
} }
em, i em.odd{
font-style: italic;
}
em.odd, i em {
font-style: normal;
}
sup { sup {
vertical-align: super; vertical-align: super;
} }
@ -86,15 +201,6 @@ sup, sub {
margin-left: 0.2ex; margin-left: 0.2ex;
} }
pre {
margin-top: 0.8em;
margin-bottom: 1.2em;
}
p, ul, ol {
margin-top: 0.5em;
margin-bottom: 1em;
}
ul, ol { ul, ol {
list-style-position: outside list-style-position: outside
} }
@ -129,17 +235,17 @@ li>*:first-child {
a { a {
text-decoration: none; text-decoration: none;
color: #2C5CBD; color: var(--link-color);
} }
a:hover { a:hover {
box-shadow: 0 1px 0 0 #2C5CBD; box-shadow: 0 1px 0 0 var(--link-color);
} }
/* Linked highlight */ /* Linked highlight */
*:target { *:target {
background-color: rgba(187,239,253,0.3) !important; background-color: var(--target-background) !important;
box-shadow: 0 0px 0 1px rgba(187,239,253,0.8) !important; box-shadow: 0 0px 0 1px var(--target-shadow) !important;
border-radius: 1px; border-radius: 1px;
} }
@ -148,13 +254,13 @@ a:hover {
} }
a.anchor:before { a.anchor:before {
content: "#" content: "#";
} }
a.anchor:hover { a.anchor:hover {
box-shadow: none; box-shadow: none;
text-decoration: none; text-decoration: none;
color: #555; color: var(--anchor-hover);
} }
a.anchor { a.anchor {
@ -168,7 +274,7 @@ a.anchor {
padding-right: 0.4em; padding-right: 0.4em;
padding-left: 0.4em; padding-left: 0.4em;
/* To remain selectable */ /* To remain selectable */
color: #d5d5d5; color: var(--anchor-color);
} }
.spec > a.anchor { .spec > a.anchor {
@ -177,10 +283,10 @@ a.anchor {
} }
.xref-unresolved { .xref-unresolved {
color: #2C5CBD; color: #2C94BD;
} }
.xref-unresolved:hover { .xref-unresolved:hover {
box-shadow: 0 1px 0 0 #CC6666; box-shadow: 0 1px 0 0 var(--xref-shadow);
} }
/* Section and document divisions. /* Section and document divisions.
@ -190,7 +296,6 @@ a.anchor {
h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 { h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 {
font-family: "Fira Sans", Helvetica, Arial, sans-serif; font-family: "Fira Sans", Helvetica, Arial, sans-serif;
font-weight: 400; font-weight: 400;
margin: 0.5em 0 0.5em 0;
padding-top: 0.1em; padding-top: 0.1em;
line-height: 1.2; line-height: 1.2;
overflow-wrap: break-word; overflow-wrap: break-word;
@ -199,13 +304,12 @@ h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 {
h1 { h1 {
font-weight: 500; font-weight: 500;
font-size: 2.441em; font-size: 2.441em;
margin-top: 1.214em;
} }
h1 { h1 {
font-weight: 500; font-weight: 500;
font-size: 1.953em; font-size: 1.953em;
box-shadow: 0 1px 0 0 #ddd; box-shadow: 0 1px 0 0 var(--header-shadow);
} }
h2 { h2 {
@ -244,6 +348,22 @@ h4 {
font-size: 1.12em; font-size: 1.12em;
} }
/* Comment delimiters, hidden but accessible to screen readers and
selected for copy/pasting */
/* Taken from bootstrap */
/* See also https://stackoverflow.com/a/27769435/4220738 */
.comment-delim {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
white-space: nowrap;
border: 0;
}
/* Preformatted and code */ /* Preformatted and code */
@ -254,20 +374,25 @@ tt, code, pre {
pre { pre {
padding: 0.1em; padding: 0.1em;
border: 1px solid #eee; border: 1px solid var(--pre-border-color);
border-radius: 5px; border-radius: 5px;
overflow-x: auto; overflow-x: auto;
} }
p code, li code { p code,
background-color: #f6f8fa; li code {
color: #0d2b3e; background-color: var(--li-code-background);
color: var(--li-code-color);
border-radius: 3px; border-radius: 3px;
padding: 0 0.3ex; padding: 0 0.3ex;
} }
p a > code { p a > code {
color: #2C5CBD; color: var(--link-color);
}
code {
white-space: pre-wrap;
} }
/* Code blocks (e.g. Examples) */ /* Code blocks (e.g. Examples) */
@ -282,57 +407,56 @@ pre code {
font-weight: 500; font-weight: 500;
} }
.arrow { white-space: nowrap }
/* Module member specification */ /* Module member specification */
.spec:not(.include), .spec.include details summary { .spec {
background-color: #f6f8fa; background-color: var(--spec-summary-background);
border-radius: 3px; border-radius: 3px;
border-left: 4px solid #5c9cf5; border-left: 4px solid var(--spec-summary-border-color);
border-right: 5px solid transparent; border-right: 5px solid transparent;
padding: 0.35em 0.5em; padding: 0.35em 0.5em;
} }
.spec.include details summary:hover { li:not(:last-child) > .def-doc {
background-color: #ebeff2; margin-bottom: 15px;
} }
dl, div.spec, .doc, aside { /* Spacing between items */
margin-bottom: 20px; div.odoc-spec,.odoc-include {
margin-bottom: 2em;
} }
dl > dd { .spec.type .variant p, .spec.type .record p {
padding: 0.5em; margin: 5px;
} }
dd> :first-child { .spec.type .variant, .spec.type .record {
margin-left: 2ch;
list-style: none;
display: flex;
flex-wrap: wrap;
row-gap: 4px;
}
.spec.type .record > code, .spec.type .variant > code {
min-width: 40%;
}
.spec.type > ol {
margin-top: 0; margin-top: 0;
}
dl:last-child, dd> :last-child, aside:last-child, article:last-child {
margin-bottom: 0; margin-bottom: 0;
} }
dt+dt { .spec.type .record > .def-doc, .spec.type .variant > .def-doc {
margin-top: 15px; min-width:50%;
} padding: 0.25em 0.5em;
margin-left: 10%;
section+section, section > header + dl { border-radius: 3px;
margin-top: 25px; flex-grow:1;
} background: var(--main-background);
box-shadow: 2px 2px 4px lightgrey;
.spec.type .variant {
margin-left: 2ch;
}
.spec.type .variant p {
margin: 0;
font-style: italic;
}
.spec.type .record {
margin-left: 2ch;
}
.spec.type .record p {
margin: 0;
font-style: italic;
} }
div.def { div.def {
@ -341,27 +465,21 @@ div.def {
padding-left: 2ex; padding-left: 2ex;
} }
div.def+div.doc { div.def-doc>*:first-child {
margin-left: 1ex;
margin-top: 2.5px
}
div.doc>*:first-child {
margin-top: 0; margin-top: 0;
} }
/* The elements other than heading should be wrapped in <aside> elements. */
/* heading, body>p, body>ul, body>ol, h3, h4, body>pre { */
/* margin-bottom: 30px; */
/* } */
/* Collapsible inlined include and module */ /* Collapsible inlined include and module */
.spec.include details { .odoc-include details {
position: relative; position: relative;
} }
.spec.include details:after { .odoc-include.shadowed-include {
display: none;
}
.odoc-include details:after {
z-index: -100; z-index: -100;
display: block; display: block;
content: " "; content: " ";
@ -371,19 +489,23 @@ div.doc>*:first-child {
top: 1px; top: 1px;
bottom: 1px; bottom: 1px;
width: 15px; width: 15px;
background: rgba(0, 4, 15, 0.05); background: var(--spec-details-after-background, rgba(0, 4, 15, 0.05));
box-shadow: 0 0px 0 1px rgba(204, 204, 204, 0.53); box-shadow: 0 0px 0 1px var(--spec-details-after-shadow, rgba(204, 204, 204, 0.53));
} }
.spec.include details summary { .odoc-include summary {
position: relative; position: relative;
margin-bottom: 20px; margin-bottom: 1em;
cursor: pointer; cursor: pointer;
outline: none; outline: none;
} }
.odoc-include summary:hover {
background-color: var(--spec-summary-hover-background);
}
/* FIXME: Does not work in Firefox. */ /* FIXME: Does not work in Firefox. */
details summary::-webkit-details-marker { .odoc-include summary::-webkit-details-marker {
color: #888; color: #888;
transform: scaleX(-1); transform: scaleX(-1);
position: absolute; position: absolute;
@ -401,116 +523,50 @@ div.def table {
} }
td.def { td.def {
padding-right: 2ex
}
.record td.def {
padding-left: 2ex; padding-left: 2ex;
} }
td.doc *:first-child { td.def-doc *:first-child {
margin-top: 0em margin-top: 0em;
} }
/* @ tags */ /* Lists of @tags */
ul.at-tag { .at-tags { list-style-type: none; margin-left: -3ex; }
list-style-type: none; .at-tags li { padding-left: 3ex; text-indent: -3ex; }
margin-left: 0; .at-tags .at-tag { text-transform: capitalize }
padding: 0;
}
ul.at-tag li { /* Lists of modules */
margin-left: 0;
padding: 0;
}
ul.at-tag li p:first-child { .modules { list-style-type: none; margin-left: -3ex; }
margin-top: 0 .modules li { padding-left: 3ex; text-indent: -3ex; margin-top: 5px }
} .modules .synopsis { padding-left: 1ch; }
/* FIXME remove */
span.at-tag {
font-weight: bold
}
.at-tag.deprecated {
font-weight: normal;
color: crimson
}
.at-tag.raise {
font-weight: bold;
}
/* FIXME random other things to review. */
.heading {
margin-top: 10px;
border-bottom: solid;
border-width: 1px;
border-color: #DDD;
text-align: right;
font-weight: normal;
font-style: italic;
}
.heading+.sig {
margin-top: -20px;
}
.heading+.parameters {
margin-top: -20px;
}
/* Odig package index */ /* Odig package index */
.by-name ol, .by-tag ol, .errors ol { .packages { list-style-type: none; margin-left: -3ex; }
list-style-type: none; .packages li { padding-left: 3ex; text-indent: -3ex }
margin-left: 0; .packages li a.anchor { padding-right: 0.5ch; padding-left: 3ch; }
} .packages .version { font-size: 10px; color: var(--by-name-version-color); }
.packages .synopsis { padding-left: 1ch }
.by-name ol ol, .by-tag ol ol {
margin-top: 0;
margin-bottom: 0
}
.by-name li, .by-tag li, .errors li {
margin-left: 0;
}
.by-name .version {
font-size: 10px;
color: #AAA
}
.by-name nav {
margin-bottom: 10px
}
.by-name nav a { .by-name nav a {
text-transform: uppercase; text-transform: uppercase;
font-size: 18px; font-size: 18px;
margin-right: 1ex; margin-right: 1ex;
color: #222; color: var(--by-name-nav-link-color,);
display: inline-block; display: inline-block;
} }
.by-tag nav a { .by-tag nav a {
margin-right: 1ex; margin-right: 1ex;
color: #222; color: var(--by-name-nav-link-color);
display: inline-block; display: inline-block;
} }
.by-tag>ol>li { .by-tag ol { list-style-type: none; }
margin-top: 10px; .by-tag ol.tags li { margin-left: 1ch; display: inline-block }
} .by-tag td:first-child { text-transform: uppercase; }
.by-tag>ol>li>span, .by-tag>ol>li>ol, .by-tag>ol>li>ol>li {
display: inline-block;
margin-right: 1ex;
}
/* Odig package page */ /* Odig package page */
@ -524,32 +580,6 @@ span.at-tag {
font-size: 14px; font-size: 14px;
} }
h1+.modules, h1+.sel {
margin-top: 10px
}
.sel {
font-weight: normal;
font-style: italic;
font-size: 14px;
margin-top: 20px;
}
.sel+.modules {
margin-top: 10px;
margin-bottom: 20px;
margin-left: 1ex;
}
.modules {
margin: 0;
}
.modules .module {
min-width: 8ex;
padding-right: 2ex
}
.package.info { .package.info {
margin: 0; margin: 0;
} }
@ -577,18 +607,18 @@ h1+.modules, h1+.sel {
/* Sidebar and TOC */ /* Sidebar and TOC */
.toc:before { .odoc-toc:before {
display: block; display: block;
content: "Contents"; content: "Contents";
text-transform: uppercase; text-transform: uppercase;
font-size: 1em; font-size: 1em;
margin: 1.414em 0 0.5em; margin: 1.414em 0 0.5em;
font-weight: 500; font-weight: 500;
color: #777; color: var(--toc-before-color);
line-height: 1.2; line-height: 1.2;
} }
.toc { .odoc-toc {
position: fixed; position: fixed;
top: 0px; top: 0px;
bottom: 0px; bottom: 0px;
@ -596,50 +626,50 @@ h1+.modules, h1+.sel {
max-width: 30ex; max-width: 30ex;
min-width: 26ex; min-width: 26ex;
width: 20%; width: 20%;
background: #f6f8fa; background: var(--toc-background);
overflow: auto; overflow: auto;
color: #1F2D3D; color: var(--toc-color);
padding-left: 2ex; padding-left: 2ex;
padding-right: 2ex; padding-right: 2ex;
} }
.toc ul li a { .odoc-toc ul li a {
font-family: "Fira Sans", sans-serif; font-family: "Fira Sans", sans-serif;
font-size: 0.95em; font-size: 0.95em;
color: #333; color: var(--color);
font-weight: 400; font-weight: 400;
line-height: 1.6em; line-height: 1.6em;
display: block; display: block;
} }
.toc ul li a:hover { .odoc-toc ul li a:hover {
box-shadow: none; box-shadow: none;
text-decoration: underline; text-decoration: underline;
} }
/* First level titles */ /* First level titles */
.toc>ul>li>a { .odoc-toc>ul>li>a {
font-weight: 500; font-weight: 500;
} }
.toc li ul { .odoc-toc li ul {
margin: 0px; margin: 0px;
} }
.toc ul { .odoc-toc ul {
list-style-type: none; list-style-type: none;
} }
.toc ul li { .odoc-toc ul li {
margin: 0; margin: 0;
} }
.toc>ul>li { .odoc-toc>ul>li {
margin-bottom: 0.3em; margin-bottom: 0.3em;
} }
.toc ul li li { .odoc-toc ul li li {
border-left: 1px solid #ccc; border-left: 1px solid var(--toc-list-border);
margin-left: 5px; margin-left: 5px;
padding-left: 12px; padding-left: 12px;
} }
@ -647,11 +677,10 @@ h1+.modules, h1+.sel {
/* Mobile adjustements. */ /* Mobile adjustements. */
@media only screen and (max-width: 95ex) { @media only screen and (max-width: 95ex) {
.content { body.odoc {
margin: auto; margin: 2em;
padding: 2.0em;
} }
.toc { .odoc-toc {
position: static; position: static;
width: auto; width: auto;
min-width: unset; min-width: unset;
@ -659,6 +688,7 @@ h1+.modules, h1+.sel {
border: none; border: none;
padding: 0.2em 1em; padding: 0.2em 1em;
border-radius: 5px; border-radius: 5px;
margin-bottom: 2em;
} }
} }
@ -678,9 +708,9 @@ h1+.modules, h1+.sel {
.hljs { .hljs {
display: block; display: block;
background: white; background: var(--code-background);
padding: 0.5em; padding: 0.5em;
color: #333333; color: var(--color);
overflow-x: auto; overflow-x: auto;
} }