Update webauthn doc to 0.1.0.

This commit is contained in:
Reynir Björnsson 2021-11-18 15:08:46 +01:00
parent 9d61302f7a
commit a2f08c11f0
7 changed files with 223 additions and 209 deletions

View file

@ -11,7 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="webauthn/index.html">webauthn</a> <span class="version">44efdb1</span></li>
<li><a href="webauthn/index.html">webauthn</a> <span class="version">0.1.0</span></li>
</ol>
</div>
</main>

View file

@ -1,13 +1,125 @@
@charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
odoc 1.5.3 */
odoc 2.0.0 */
/* Fonts */
@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=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. */
@ -15,13 +127,9 @@ html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockq
margin: 0;
padding: 0;
border: 0;
font-size: inherit;
font: inherit;
line-height: inherit;
vertical-align: baseline;
text-align: inherit;
color: inherit;
background: transparent;
}
table {
@ -38,13 +146,13 @@ html {
}
body {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
text-align: left;
color: #333;
background: #FFFFFF;
color: var(--color);
background-color: var(--main-background);
}
.content {
body {
max-width: 90ex;
margin-left: calc(10vw + 20ex);
margin-right: 4ex;
@ -54,24 +162,32 @@ body {
line-height: 1.5;
}
.content>header {
header {
margin-bottom: 30px;
}
.content>header nav {
nav {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
}
/* Basic markup elements */
b, strong {
font-weight: 500;
font-weight: bold;
}
i, em {
i {
font-style: italic;
}
em, i em.odd{
font-style: italic;
}
em.odd, i em {
font-style: normal;
}
sup {
vertical-align: super;
}
@ -129,32 +245,32 @@ li>*:first-child {
a {
text-decoration: none;
color: #2C5CBD;
color: var(--link-color);
}
a:hover {
box-shadow: 0 1px 0 0 #2C5CBD;
box-shadow: 0 1px 0 0 var(--link-color);
}
/* Linked highlight */
*:target {
background-color: rgba(187,239,253,0.3) !important;
box-shadow: 0 0px 0 1px rgba(187,239,253,0.8) !important;
background-color: var(--target-background) !important;
box-shadow: 0 0px 0 1px var(--target-shadow) !important;
border-radius: 1px;
}
*:hover>a.anchor {
*:hover > a.anchor {
visibility: visible;
}
a.anchor:before {
content: "#"
content: "#";
}
a.anchor:hover {
box-shadow: none;
text-decoration: none;
color: #555;
color: var(--anchor-hover);
}
a.anchor {
@ -168,7 +284,7 @@ a.anchor {
padding-right: 0.4em;
padding-left: 0.4em;
/* To remain selectable */
color: #d5d5d5;
color: var(--anchor-color);
}
.spec > a.anchor {
@ -177,10 +293,10 @@ a.anchor {
}
.xref-unresolved {
color: #2C5CBD;
color: #2C94BD;
}
.xref-unresolved:hover {
box-shadow: 0 1px 0 0 #CC6666;
box-shadow: 0 1px 0 0 var(--xref-shadow);
}
/* Section and document divisions.
@ -205,7 +321,7 @@ h1 {
h1 {
font-weight: 500;
font-size: 1.953em;
box-shadow: 0 1px 0 0 #ddd;
box-shadow: 0 1px 0 0 var(--header-shadow);
}
h2 {
@ -244,6 +360,22 @@ h4 {
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 */
@ -254,20 +386,21 @@ tt, code, pre {
pre {
padding: 0.1em;
border: 1px solid #eee;
border: 1px solid var(--pre-border-color);
border-radius: 5px;
overflow-x: auto;
}
p code, li code {
background-color: #f6f8fa;
color: #0d2b3e;
p code,
li code {
background-color: var(--li-code-background);
color: var(--li-code-color);
border-radius: 3px;
padding: 0 0.3ex;
}
p a > code {
color: #2C5CBD;
color: var(--link-color);
}
/* Code blocks (e.g. Examples) */
@ -282,44 +415,22 @@ pre code {
font-weight: 500;
}
.arrow { white-space: nowrap }
/* Module member specification */
.spec:not(.include), .spec.include details summary {
background-color: #f6f8fa;
.spec {
background-color: var(--spec-summary-background);
border-radius: 3px;
border-left: 4px solid #5c9cf5;
border-left: 4px solid var(--spec-summary-border-color);
border-right: 5px solid transparent;
padding: 0.35em 0.5em;
}
.spec.include details summary:hover {
background-color: #ebeff2;
}
dl, div.spec, .doc, aside {
div.spec, .def-doc {
margin-bottom: 20px;
}
dl > dd {
padding: 0.5em;
}
dd> :first-child {
margin-top: 0;
}
dl:last-child, dd> :last-child, aside:last-child, article:last-child {
margin-bottom: 0;
}
dt+dt {
margin-top: 15px;
}
section+section, section > header + dl {
margin-top: 25px;
}
.spec.type .variant {
margin-left: 2ch;
}
@ -341,27 +452,22 @@ div.def {
padding-left: 2ex;
}
div.def+div.doc {
div.def+div.def-doc {
margin-left: 1ex;
margin-top: 2.5px
}
div.doc>*:first-child {
div.def-doc>*:first-child {
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 */
.spec.include details {
.odoc-include details {
position: relative;
}
.spec.include details:after {
.odoc-include details:after {
z-index: -100;
display: block;
content: " ";
@ -371,19 +477,23 @@ div.doc>*:first-child {
top: 1px;
bottom: 1px;
width: 15px;
background: rgba(0, 4, 15, 0.05);
box-shadow: 0 0px 0 1px rgba(204, 204, 204, 0.53);
background: var(--spec-details-after-background, rgba(0, 4, 15, 0.05));
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;
margin-bottom: 20px;
cursor: pointer;
outline: none;
}
.odoc-include summary:hover {
background-color: var(--spec-summary-hover-background);
}
/* FIXME: Does not work in Firefox. */
details summary::-webkit-details-marker {
.odoc-include summary::-webkit-details-marker {
color: #888;
transform: scaleX(-1);
position: absolute;
@ -401,116 +511,50 @@ div.def table {
}
td.def {
padding-right: 2ex
}
.record td.def {
padding-left: 2ex;
}
td.doc *:first-child {
margin-top: 0em
td.def-doc *:first-child {
margin-top: 0em;
}
/* @ tags */
/* Lists of @tags */
ul.at-tag {
list-style-type: none;
margin-left: 0;
padding: 0;
}
.at-tags { list-style-type: none; margin-left: -3ex; }
.at-tags li { padding-left: 3ex; text-indent: -3ex; }
.at-tags .at-tag { text-transform: capitalize }
ul.at-tag li {
margin-left: 0;
padding: 0;
}
/* Lists of modules */
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: 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;
}
.modules { list-style-type: none; margin-left: -3ex; }
.modules li { padding-left: 3ex; text-indent: -3ex; margin-top: 5px }
.modules .synopsis { padding-left: 1ch; }
/* 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: 10px;
color: #AAA
}
.by-name nav {
margin-bottom: 10px
}
.packages { list-style-type: none; margin-left: -3ex; }
.packages li { padding-left: 3ex; text-indent: -3ex }
.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 nav a {
text-transform: uppercase;
font-size: 18px;
margin-right: 1ex;
color: #222;
color: var(--by-name-nav-link-color,);
display: inline-block;
}
.by-tag nav a {
margin-right: 1ex;
color: #222;
color: var(--by-name-nav-link-color);
display: inline-block;
}
.by-tag>ol>li {
margin-top: 10px;
}
.by-tag>ol>li>span, .by-tag>ol>li>ol, .by-tag>ol>li>ol>li {
display: inline-block;
margin-right: 1ex;
}
.by-tag ol { list-style-type: none; }
.by-tag ol.tags li { margin-left: 1ch; display: inline-block }
.by-tag td:first-child { text-transform: uppercase; }
/* Odig package page */
@ -524,32 +568,6 @@ span.at-tag {
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 {
margin: 0;
}
@ -577,18 +595,18 @@ h1+.modules, h1+.sel {
/* Sidebar and TOC */
.toc:before {
.odoc-toc:before {
display: block;
content: "Contents";
text-transform: uppercase;
font-size: 1em;
margin: 1.414em 0 0.5em;
font-weight: 500;
color: #777;
color: var(--toc-before-color);
line-height: 1.2;
}
.toc {
.odoc-toc {
position: fixed;
top: 0px;
bottom: 0px;
@ -596,50 +614,50 @@ h1+.modules, h1+.sel {
max-width: 30ex;
min-width: 26ex;
width: 20%;
background: #f6f8fa;
background: var(--toc-background);
overflow: auto;
color: #1F2D3D;
color: var(--toc-color);
padding-left: 2ex;
padding-right: 2ex;
}
.toc ul li a {
.odoc-toc ul li a {
font-family: "Fira Sans", sans-serif;
font-size: 0.95em;
color: #333;
color: var(--color);
font-weight: 400;
line-height: 1.6em;
display: block;
}
.toc ul li a:hover {
.odoc-toc ul li a:hover {
box-shadow: none;
text-decoration: underline;
}
/* First level titles */
.toc>ul>li>a {
.odoc-toc>ul>li>a {
font-weight: 500;
}
.toc li ul {
.odoc-toc li ul {
margin: 0px;
}
.toc ul {
.odoc-toc ul {
list-style-type: none;
}
.toc ul li {
.odoc-toc ul li {
margin: 0;
}
.toc>ul>li {
.odoc-toc>ul>li {
margin-bottom: 0.3em;
}
.toc ul li li {
border-left: 1px solid #ccc;
.odoc-toc ul li li {
border-left: 1px solid var(--toc-list-border);
margin-left: 5px;
padding-left: 12px;
}
@ -647,11 +665,11 @@ h1+.modules, h1+.sel {
/* Mobile adjustements. */
@media only screen and (max-width: 95ex) {
.content {
.odoc-content {
margin: auto;
padding: 2.0em;
padding: 2em;
}
.toc {
.odoc-toc {
position: static;
width: auto;
min-width: unset;
@ -678,9 +696,9 @@ h1+.modules, h1+.sel {
.hljs {
display: block;
background: white;
background: var(--code-background);
padding: 0.5em;
color: #333333;
color: var(--color);
overflow-x: auto;
}

View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Simple (webauthn.CBOR.Simple)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.3"/><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="../index.html">Up</a> <a href="../../index.html">webauthn</a> &#x00BB; <a href="../index.html">CBOR</a> &#x00BB; Simple</nav><h1>Module <code>CBOR.Simple</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code> = <code>[ </code><table class="variant"><tr id="type-t.Null" class="anchored"><td class="def constructor"><a href="#type-t.Null" class="anchor"></a><code>| </code><code>`Null</code></td></tr><tr id="type-t.Undefined" class="anchored"><td class="def constructor"><a href="#type-t.Undefined" class="anchor"></a><code>| </code><code>`Undefined</code></td></tr><tr id="type-t.Simple" class="anchored"><td class="def constructor"><a href="#type-t.Simple" class="anchor"></a><code>| </code><code>`Simple <span class="keyword">of</span> int</code></td></tr><tr id="type-t.Bool" class="anchored"><td class="def constructor"><a href="#type-t.Bool" class="anchor"></a><code>| </code><code>`Bool <span class="keyword">of</span> bool</code></td></tr><tr id="type-t.Int" class="anchored"><td class="def constructor"><a href="#type-t.Int" class="anchor"></a><code>| </code><code>`Int <span class="keyword">of</span> int</code></td></tr><tr id="type-t.Float" class="anchored"><td class="def constructor"><a href="#type-t.Float" class="anchor"></a><code>| </code><code>`Float <span class="keyword">of</span> float</code></td></tr><tr id="type-t.Bytes" class="anchored"><td class="def constructor"><a href="#type-t.Bytes" class="anchor"></a><code>| </code><code>`Bytes <span class="keyword">of</span> string</code></td></tr><tr id="type-t.Text" class="anchored"><td class="def constructor"><a href="#type-t.Text" class="anchor"></a><code>| </code><code>`Text <span class="keyword">of</span> string</code></td></tr><tr id="type-t.Array" class="anchored"><td class="def constructor"><a href="#type-t.Array" class="anchor"></a><code>| </code><code>`Array <span class="keyword">of</span> <span><a href="index.html#type-t">t</a> list</span></code></td></tr><tr id="type-t.Map" class="anchored"><td class="def constructor"><a href="#type-t.Map" class="anchor"></a><code>| </code><code>`Map <span class="keyword">of</span> <span><span>(<a href="index.html#type-t">t</a> * <a href="index.html#type-t">t</a>)</span> list</span></code></td></tr></table><code> ]</code></dt></dl><dl><dt class="spec value" id="val-encode"><a href="#val-encode" class="anchor"></a><code><span class="keyword">val</span> encode : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span class="keyword">val</span> decode : string <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-decode_partial"><a href="#val-decode_partial" class="anchor"></a><code><span class="keyword">val</span> decode_partial : string <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> * string</code></dt><dt class="spec value" id="val-to_diagnostic"><a href="#val-to_diagnostic" class="anchor"></a><code><span class="keyword">val</span> to_diagnostic : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt></dl></div></body></html>

View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CBOR (webauthn.CBOR)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.3"/><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="../index.html">Up</a> <a href="../index.html">webauthn</a> &#x00BB; CBOR</nav><h1>Module <code>CBOR</code></h1><p>CBOR encoder/decoder, RFC 7049</p></header><dl><dt class="spec exception" id="exception-Error"><a href="#exception-Error" class="anchor"></a><code><span class="keyword">exception</span> </code><code><span class="exception">Error</span> <span class="keyword">of</span> string</code></dt></dl><div class="spec module" id="module-Simple"><a href="#module-Simple" class="anchor"></a><code><span class="keyword">module</span> <a href="Simple/index.html">Simple</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (webauthn.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.3"/><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="../index.html">Up</a> webauthn</nav><h1 id="webauthn-index"><a href="#webauthn-index" class="anchor"></a>webauthn index</h1><nav class="toc"><ul><li><a href="#library-webauthn">Library webauthn</a></li><li><a href="#library-webauthn.cbor">Library webauthn.cbor</a></li></ul></nav></header><h2 id="library-webauthn"><a href="#library-webauthn" class="anchor"></a>Library webauthn</h2><p>The entry point of this library is the module: <a href="Webauthn/index.html"><code>Webauthn</code></a>.</p><h2 id="library-webauthn.cbor"><a href="#library-webauthn.cbor" class="anchor"></a>Library webauthn.cbor</h2><p>The entry point of this library is the module: <a href="CBOR/index.html"><code>CBOR</code></a>.</p></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (webauthn.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.0.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> webauthn</nav><header class="odoc-preamble"><h1 id="webauthn-index"><a href="#webauthn-index" class="anchor"></a>webauthn index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-webauthn">Library webauthn</a></li></ul></nav><div class="odoc-content"><h2 id="library-webauthn"><a href="#library-webauthn" class="anchor"></a>Library webauthn</h2><p>The entry point of this library is the module: <a href="Webauthn/index.html"><code>Webauthn</code></a>.</p></div></body></html>