Deploying to gh-pages from @ fedaeef 🚀

savonet · Sep 4, 2024 · b5dae63 · b5dae63
1 parent c9cbf1d
commit b5dae63
Show file tree

Hide file tree

Showing 19 changed files with 985 additions and 147 deletions.
diff --git a/odoc.support/fonts/fira-mono-v14-latin-500.woff2 b/odoc.support/fonts/fira-mono-v14-latin-500.woff2
diff --git a/odoc.support/fonts/fira-mono-v14-latin-regular.woff2 b/odoc.support/fonts/fira-mono-v14-latin-regular.woff2
diff --git a/odoc.support/fonts/fira-sans-v17-latin-500.woff2 b/odoc.support/fonts/fira-sans-v17-latin-500.woff2
diff --git a/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2 b/odoc.support/fonts/fira-sans-v17-latin-500italic.woff2
diff --git a/odoc.support/fonts/fira-sans-v17-latin-700.woff2 b/odoc.support/fonts/fira-sans-v17-latin-700.woff2
diff --git a/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2 b/odoc.support/fonts/fira-sans-v17-latin-700italic.woff2
diff --git a/odoc.support/fonts/fira-sans-v17-latin-italic.woff2 b/odoc.support/fonts/fira-sans-v17-latin-italic.woff2
diff --git a/odoc.support/fonts/fira-sans-v17-latin-regular.woff2 b/odoc.support/fonts/fira-sans-v17-latin-regular.woff2
diff --git a/odoc.support/fonts/noticia-text-v15-latin-700.woff2 b/odoc.support/fonts/noticia-text-v15-latin-700.woff2
diff --git a/odoc.support/fonts/noticia-text-v15-latin-italic.woff2 b/odoc.support/fonts/noticia-text-v15-latin-italic.woff2
diff --git a/odoc.support/fonts/noticia-text-v15-latin-regular.woff2 b/odoc.support/fonts/noticia-text-v15-latin-regular.woff2
diff --git a/odoc.support/highlight.pack.js b/odoc.support/highlight.pack.js
diff --git a/odoc.support/odoc.css b/odoc.support/odoc.css
diff --git a/odoc.support/odoc_search.js b/odoc.support/odoc_search.js
@@ -0,0 +1,66 @@
+/* The browsers interpretation of the CORS origin policy prevents to run
+   webworkers from javascript files fetched from the file:// protocol. This hack
+   is to workaround this restriction. */
+function createWebWorker() {
+  var searchs = search_urls.map((search_url) => {
+    let parts = document.location.href.split("/");
+    parts[parts.length - 1] = search_url;
+    return '"' + parts.join("/") + '"';
+  });
+  blobContents = ["importScripts(" + searchs.join(",") + ");"];
+  var blob = new Blob(blobContents, { type: "application/javascript" });
+  var blobUrl = URL.createObjectURL(blob);
+
+  var worker = new Worker(blobUrl);
+  URL.revokeObjectURL(blobUrl);
+
+  return worker;
+}
+
+var worker;
+var waiting = 0;
+
+function wait() {
+  waiting = waiting + 1;
+  document.querySelector(".search-snake").classList.add("search-busy");
+}
+
+function stop_waiting() {
+  if (waiting > 0) waiting = waiting - 1;
+  else waiting = 0;
+  if (waiting == 0) {
+    document.querySelector(".search-snake").classList.remove("search-busy");
+  }
+}
+
+document.querySelector(".search-bar").addEventListener("focus", (ev) => {
+  if (typeof worker == "undefined") {
+    worker = createWebWorker();
+    worker.onmessage = (e) => {
+      stop_waiting();
+      let results = e.data;
+      let search_results = document.querySelector(".search-result");
+      search_results.innerHTML = "";
+      let f = (entry) => {
+        let search_result = document.createElement("a");
+        search_result.classList.add("search-entry");
+        search_result.href = base_url + entry.url;
+        search_result.innerHTML = entry.html;
+        search_results.appendChild(search_result);
+      };
+      results.forEach(f);
+      let search_request = document.querySelector(".search-bar").value;
+      if (results.length == 0 && search_request != "") {
+        let no_result = document.createElement("div");
+        no_result.classList.add("search-no-result");
+        no_result.innerText = "No result...";
+        search_results.appendChild(no_result);
+      }
+    };
+  }
+});
+
+document.querySelector(".search-bar").addEventListener("input", (ev) => {
+  wait();
+  worker.postMessage(ev.target.value);
+});
diff --git a/ssl/Ssl/Error/index.html b/ssl/Ssl/Error/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Error (ssl.Ssl.Error)</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">ssl</a> &#x00BB; <a href="../index.html">Ssl</a> &#x00BB; Error</nav><header class="odoc-preamble"><h1>Module <code><span>Ssl.Error</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><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-t.library_number" class="def record field anchored"><a href="#type-t.library_number" class="anchor"></a><code><span>library_number : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Identifies the OpenSSL sub-library that generated this error. Library values are defined in https://github.com/openssl/openssl/blob/openssl-3.0.0/include/openssl/err.h.in#L72</p><span class="comment-delim">*)</span></div></li><li id="type-t.reason_code" class="def record field anchored"><a href="#type-t.reason_code" class="anchor"></a><code><span>reason_code : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The reason code is the information about what went wrong.</p><span class="comment-delim">*)</span></div></li><li id="type-t.lib" class="def record field anchored"><a href="#type-t.lib" class="anchor"></a><code><span>lib : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The library name that generated the error.</p><span class="comment-delim">*)</span></div></li><li id="type-t.reason" class="def record field anchored"><a href="#type-t.reason" class="anchor"></a><code><span>reason : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The reason string for the error message.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>The error code returned by ERR_get_error() consists of a library number, function code and reason code.</p><p>Each sub-library of OpenSSL has a unique library number; function and reason codes are unique within each sub-library. Note that different libraries may use the same value to signal different functions and reasons.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_error"><a href="#val-get_error" class="anchor"></a><code><span><span class="keyword">val</span> get_error : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Retrieve the earliest error from the error queue then it removes the entry. Returns the code and library and reason strings</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-peek_error"><a href="#val-peek_error" class="anchor"></a><code><span><span class="keyword">val</span> peek_error : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Retrieve the earliest error from the error queue without modifying it. Returns the code and library and reason strings</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-peek_last_error"><a href="#val-peek_last_error" class="anchor"></a><code><span><span class="keyword">val</span> peek_last_error : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Retrieves the latest error code from the thread's error queue without modifying it. Returns the code and library and reason strings.</p></div></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Error (ssl.Ssl.Error)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">ssl</a> &#x00BB; <a href="../index.html">Ssl</a> &#x00BB; Error</nav><header class="odoc-preamble"><h1>Module <code><span>Ssl.Error</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><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-t.library_number" class="def record field anchored"><a href="#type-t.library_number" class="anchor"></a><code><span>library_number : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Identifies the OpenSSL sub-library that generated this error. Library values are defined in https://github.com/openssl/openssl/blob/openssl-3.0.0/include/openssl/err.h.in#L72</p><span class="comment-delim">*)</span></div></li><li id="type-t.reason_code" class="def record field anchored"><a href="#type-t.reason_code" class="anchor"></a><code><span>reason_code : int;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The reason code is the information about what went wrong.</p><span class="comment-delim">*)</span></div></li><li id="type-t.lib" class="def record field anchored"><a href="#type-t.lib" class="anchor"></a><code><span>lib : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The library name that generated the error.</p><span class="comment-delim">*)</span></div></li><li id="type-t.reason" class="def record field anchored"><a href="#type-t.reason" class="anchor"></a><code><span>reason : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The reason string for the error message.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>The error code returned by ERR_get_error() consists of a library number, function code and reason code.</p><p>Each sub-library of OpenSSL has a unique library number; function and reason codes are unique within each sub-library. Note that different libraries may use the same value to signal different functions and reasons.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_error"><a href="#val-get_error" class="anchor"></a><code><span><span class="keyword">val</span> get_error : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Retrieve the earliest error from the error queue then it removes the entry. Returns the code and library and reason strings</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-peek_error"><a href="#val-peek_error" class="anchor"></a><code><span><span class="keyword">val</span> peek_error : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Retrieve the earliest error from the error queue without modifying it. Returns the code and library and reason strings</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-peek_last_error"><a href="#val-peek_last_error" class="anchor"></a><code><span><span class="keyword">val</span> peek_last_error : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Retrieves the latest error code from the thread's error queue without modifying it. Returns the code and library and reason strings.</p></div></div></div></body></html>