Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Commit

Permalink
Update webdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
mandel committed Aug 29, 2018
1 parent 96fa95d commit eec0d5b
Show file tree
Hide file tree
Showing 97 changed files with 801 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/_html/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
<body>
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="wcs/index.html">wcs</a> <span class="version">2017-05-26.05</span></li>
<li><a href="wcs-lib/index.html">wcs-lib</a> <span class="version">2017-05-26.05</span></li>
</ol>
</div>
</body>
</html>
234 changes: 234 additions & 0 deletions docs/_html/odoc.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
@charset "UTF-8";
/* Copyright (c) 2016 Daniel C. Bünzli. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
odoc 1.2.0 */

/* 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
{ margin:0; padding:0; border:0; /* outline: 0; */
font-size:100%; font: inherit; line-height:inherit; vertical-align:baseline;
text-align: inherit; color: inherit; background: transparent; }

table { border-collapse: collapse; border-spacing: 0; }
*, *:before, *:after { box-sizing: border-box; }

body
{ font-family: Helvetica, "DejaVu Sans", Arial, sans-serif;
font-weight: normal;
font-size: 0.875rem;
line-height:1.25rem;
text-align: left;
min-width: 40ex;
max-width: 78ex;
padding: 1.25rem;
margin-left: 3.75rem;
color: #222; background: #FAFAFA; }

/* Basic markup elements */

b, strong { font-weight: bold; }
em { font-style: italic; }

sup { vertical-align: super; }
sub { vertical-align: sub; }
sup, sub { font-size : 0.75rem; line-height: 0; margin-left: 0.2ex; }

p, div, img { margin-top: 1.25rem; }

ul, ol
{ margin-top: 0.625rem; margin-bottom: 0.625rem; list-style-position: outside }

ul { list-style-type: square }
ul > li { margin-left: 1.375rem; }
ol > li { margin-left: 1.7rem; }
li > *:first-child { margin-top: 0 }

/* Text alignements, this should be forbidden. */

.left { text-align: left; }
.right { text-align: right; }
.center { text-align: center; }

/* Links and anchors */

a { text-decoration:none; color:#2C5CBD; }
a:hover { box-shadow:0 1px 0 0 #2C5CBD; }
*:target /* Linked highlight */
{ background-color: #FFF8E5;
box-shadow: 0 0 0 2px #FFF8E5, 0 0 0 3px #DDD; }

.spec:hover > a.anchor, /* FIXME remove */
.anchored:hover a.anchor { visibility: visible; }

a.anchor:before { content: "#" }
a.anchor:hover { box-shadow: none; text-decoration: underline }
a.anchor
{ visibility: hidden; position: absolute; /* top: 0px; */
margin-left: -3ex;
font-weight: normal;
font-style: normal;
padding-right: 1ex; padding-left: 1ex; /* To remain selectable */
color: #AAA; }

.xref-unresolved { box-shadow:0 1px 0 0 red }

/* Section and document divisions.
Until at least 4.03 many of the modules of the stdlib start at .h7,
we restart the sequence there like h2 */

h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10
{ font-weight: bold; margin-top: 1.25rem; }

h1 + *, h2 + *, .h7 + * { margin-top: 0.625rem; }
h1, h2, .h7
{ font-size: 1.25rem;
line-height: 2.4375rem; /* 2.5rem - border width */
padding-top: 0.625rem;
border-top: solid;
border-width: 1px;
border-color: #DDD; }

h3, .h8 { font-size: 1.125rem; }
h2 + h3, .h7 + .h8 { margin-top: 0.625rem; }

/* Preformatted and code */

tt, code, pre
{ font-family: Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono",
monospace;
font-weight: normal;
font-size: 0.75rem; }

pre
{ padding-left: 0.25rem; padding-right: 0.25rem;
margin-left: -0.25rem; margin-right: -0.25rem;
padding-top: 0.3125rem; padding-bottom: 0.3125rem;
margin-top: 1.25rem; /* margin-bottom: 0.625rem; */
line-height: 1.1875rem;
background: #F1F1F1; }

h1 tt, h1 code, h2 tt, h2 code, .h7 tt, .h7 code { font-size: 1.125rem }
h3 tt, h3 code { font-size: 1rem }

/* Code lexemes */

.keyword { font-weight: bold; }

/* Module member specification */

div.def { margin-top: 0rem; text-indent: -2ex; padding-left: 2ex; }
div.def + div.doc { margin-left: 1ex; margin-top: 0.15625rem }
div.doc > *:first-child { margin-top: 0rem; }

/* Collapsible inlined include and module */

details
{ border-radius: 0.5rem;
border-left: 0.2rem solid;
border-color: #FAFAFA /* Background */;
margin-left: -1.5rem;
padding-left: 1.3rem;
padding-bottom: 0.625rem; }

details[open] { border-color: #AAA; }

/* Records and variants FIXME */

div.def table { text-indent: 0em; padding:0; margin-left: -2ex; }
td.def { padding-right: 2ex }
.record td.def { padding-left:2ex; }
td.doc *:first-child { margin-top: 0em }

/* @ tags */

ul.at-tag { list-style-type: none; margin-left: 0; padding: 0; }
ul.at-tag li { margin-left:0; padding:0; }
ul.at-tag li p:first-child { margin-top: 0 } /* 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: 0.625rem;
border-top: solid;
border-width: 1px;
border-color: #DDD;
text-align: right;
font-weight: normal;
font-style: italic; }

.heading + .sig { margin-top: -1.25rem; }
.heading + .parameters { margin-top: -1.25rem; }

/* Odig package index */

.by-name ol, .by-tag ol, .errors ol { list-style-type: none; margin-left:0; }
.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: 0.625rem; color: #AAA }
.by-name nav { margin-bottom: 0.625rem }
.by-name nav a
{ text-transform: uppercase; font-size: 1.125rem;
margin-right:1ex; color: #222; display: inline-block; }

.by-tag nav a { margin-right:1ex; color: #222; display: inline-block; }
.by-tag > ol > li { margin-top: 0.625rem; }
.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 */

.package nav { display: inline; font-size: 0.875rem; font-weight: normal; }
.package .version { font-size: 0.875rem; }

h1 + .modules, h1 + .sel { margin-top: 0.625rem }
.sel { font-weight: normal; font-style: italic;
font-size:0.875rem; margin-top:1.25rem; }
.sel + .modules { margin-top:0.625rem;
margin-bottom: 1.25rem; margin-left: 1ex; }

.modules { margin:0; }
.modules .module { min-width:8ex; padding-right: 2ex }

.package.info { margin: 0;}
.package.info td:first-child { font-style: italic; padding-right: 2ex; }
.package.info ul { list-style-type: none; display: inline; margin:0; }
.package.info li { display: inline-block; margin:0; margin-right:1ex; }
#info-authors li, #info-maintainers li { display:block; }

/* Mobile adjustements. */

@media only screen and (max-width: 78ex)
{ body { margin: auto; } }

/* Print adjustements. */

@media print
{ body { color: black; background: white; }
body nav:first-child { visibility: hidden; }}

/*---------------------------------------------------------------------------
Copyright (c) 2016 Daniel C. Bünzli
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
---------------------------------------------------------------------------*/
2 changes: 2 additions & 0 deletions docs/_html/wcs-lib/Wcs_lib/Atdgen_to_rml/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Atdgen_to_rml (wcs-lib.Wcs_lib.Atdgen_to_rml)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../../index.html">wcs-lib</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">Wcs_lib.Atdgen_to_rml</span></h1></header><div class="spec val" id="val-output_line"><a href="#val-output_line" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>output_line : Pervasives.out_channel <span class="keyword">&#8209;&gt;</span> string <span class="keyword">&#8209;&gt;</span> unit</code></div><div class="doc"></div></div></body></html>
14 changes: 14 additions & 0 deletions docs/_html/wcs-lib/Wcs_lib/Context/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Context (wcs-lib.Wcs_lib.Context)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> &mdash; <span class="package">package <a href="../../index.html">wcs-lib</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">Wcs_lib.Context</span></h1></header><div class="h9">The <code class="code">&quot;skip_user_input&quot;</code> field</div><div class="spec val" id="val-skip_user_input_lbl"><a href="#val-skip_user_input_lbl" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>skip_user_input_lbl : string</code></div><div class="doc"><p>The <code class="code">&quot;skip_user_input&quot;</code> string.</p></div></div><div class="spec val" id="val-skip_user_input"><a href="#val-skip_user_input" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>skip_user_input : bool <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">skip_user_input b</code> creates the JSON object <code class="code">{ &quot;skip_user_input&quot; : b }</code>.</p></div></div><div class="spec val" id="val-set_skip_user_input"><a href="#val-set_skip_user_input" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>set_skip_user_input : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> bool <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">set_skip_user_input ctx b</code> set the field <code class="code">&quot;skip_user_input&quot;</code> of
the object <code class="code">ctx</code> with value <code class="code">b</code>.</p></div></div><div class="spec val" id="val-take_skip_user_input"><a href="#val-take_skip_user_input" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>take_skip_user_input : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a><span class="keyword"> * </span>bool</code></div><div class="doc"><p><code class="code">take_skip_user_input ctx</code> take the field <code class="code">&quot;skip_user_input&quot;</code> of
the object <code class="code">ctx</code>. If the field is the defined, it returns <code class="code">false</code>.</p></div></div><div class="h9">The <code class="code">&quot;actions&quot;</code> field</div><div class="spec val" id="val-actions_lbl"><a href="#val-actions_lbl" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>actions_lbl : string</code></div><div class="doc"><p>The <code class="code">&quot;actions&quot;</code> string.</p></div></div><div class="spec val" id="val-actions"><a href="#val-actions" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>actions : <a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> list <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">actions acts</code> creates the JSON object <code class="code">{ &quot;actions&quot; : acts }</code>.</p></div></div><div class="spec val" id="val-set_actions"><a href="#val-set_actions" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>set_actions : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> list <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">set_actions ctx l</code> set the field <code class="code">&quot;actions&quot;</code> of
the object <code class="code">ctx</code> with the list of actions <code class="code">l</code>.</p></div></div><div class="spec val" id="val-take_actions"><a href="#val-take_actions" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>take_actions : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a><span class="keyword"> * </span><a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> list option</code></div><div class="doc"><p><code class="code">take_actions ctx</code> take the field <code class="code">&quot;actions&quot;</code> of the object
<code class="code">ctx</code>.</p></div></div><div class="spec val" id="val-push_action"><a href="#val-push_action" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>push_action : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">push_action ctx act</code> add the action <code class="code">act</code> in the list of actions
stored in the field <code class="code">&quot;actions&quot;</code> of ctx. It the field <code class="code">&quot;actions&quot;</code>
doesn't exists, it creates it.</p></div></div><div class="spec val" id="val-pop_action"><a href="#val-pop_action" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pop_action : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a><span class="keyword"> * </span><a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> option</code></div><div class="doc"><p><code class="code">pop_action ctx</code> take an action <code class="code">act</code> in the list of actions
stored in the field <code class="code">&quot;actions&quot;</code> of ctx.</p></div></div><div class="h9">The <code class="code">&quot;continuation&quot;</code> field</div><div class="spec val" id="val-continuation_lbl"><a href="#val-continuation_lbl" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>continuation_lbl : string</code></div><div class="doc"><p>The <code class="code">&quot;continuation&quot;</code> string.</p></div></div><div class="spec val" id="val-set_continuation"><a href="#val-set_continuation" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>set_continuation : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">set_continuation ctx act</code> set the field <code class="code">&quot;continuation&quot;</code> of
the object <code class="code">ctx</code> with the action <code class="code">act</code>.</p></div></div><div class="spec val" id="val-get_continuation"><a href="#val-get_continuation" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_continuation : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> option</code></div><div class="doc"><p><code class="code">get_continuation ctx</code> get the value of the field <code class="code">&quot;continuation&quot;</code>
of the object <code class="code">ctx</code>.</p></div></div><div class="spec val" id="val-take_continuation"><a href="#val-take_continuation" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>take_continuation : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a><span class="keyword"> * </span><a href="../Wcs_t/index.html#type-action">Wcs_t.action</a> option</code></div><div class="doc"><p><code class="code">take_continuation ctx</code> take the value of the field <code class="code">&quot;continuation&quot;</code>
of the object <code class="code">ctx</code>.</p></div></div><div class="h9">The <code class="code">&quot;return&quot;</code> field</div><div class="spec val" id="val-return_lbl"><a href="#val-return_lbl" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return_lbl : string</code></div><div class="doc"><p>The <code class="code">&quot;return&quot;</code> string.</p></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">return v</code> creates the JSON object <code class="code">{ &quot;return&quot; : v }</code>.</p></div></div><div class="spec val" id="val-set_return"><a href="#val-set_return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>set_return : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a></code></div><div class="doc"><p><code class="code">set_return ctx v</code> set the field <code class="code">&quot;return&quot;</code> of
the object <code class="code">ctx</code> with the value <code class="code">v</code>.</p></div></div><div class="spec val" id="val-get_return"><a href="#val-get_return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_return : <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> <span class="keyword">&#8209;&gt;</span> <a href="../Wcs_t/index.html#type-json">Wcs_t.json</a> option</code></div><div class="doc"><p><code class="code">get_return ctx</code> get the value of the field <code class="code">&quot;return&quot;</code>
of the object <code class="code">ctx</code>.</p></div></div></body></html>
Loading

0 comments on commit eec0d5b

Please sign in to comment.