Skip to content

Commit

Permalink
Update fpath-base doc to 0.1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
mbarbin committed Sep 3, 2024
1 parent e7152db commit 59b2a21
Show file tree
Hide file tree
Showing 18 changed files with 47 additions and 7 deletions.
4 changes: 4 additions & 0 deletions fpath-base-tests/Fpath_base_test/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fpath_base_test (fpath-base-tests.Fpath_base_test)</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><script>let base_url = '../../';
let search_urls = ['../db.js','../../sherlodoc.js'];
</script><script src="../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">fpath-base-tests</a> &#x00BB; Fpath_base_test</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Fpath_base_test</span></code></h1></header><div class="odoc-content"></div></body></html>
4 changes: 4 additions & 0 deletions fpath-base-tests/Fpath_sexp0_test/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fpath_sexp0_test (fpath-base-tests.Fpath_sexp0_test)</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><script>let base_url = '../../';
let search_urls = ['../db.js','../../sherlodoc.js'];
</script><script src="../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">fpath-base-tests</a> &#x00BB; Fpath_sexp0_test</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Fpath_sexp0_test</span></code></h1></header><div class="odoc-content"></div></body></html>
1 change: 1 addition & 0 deletions fpath-base-tests/db.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions fpath-base-tests/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (fpath-base-tests.index)</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><script>let base_url = '../';
let search_urls = ['db.js','../sherlodoc.js'];
</script><script src="../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – fpath-base-tests</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1 id="fpath-base-tests-index"><a href="#fpath-base-tests-index" class="anchor"></a>fpath-base-tests index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-fpath-base-tests.fpath_base_test">Library fpath-base-tests.fpath_base_test</a></li><li><a href="#library-fpath-base-tests.fpath_sexp0_test">Library fpath-base-tests.fpath_sexp0_test</a></li></ul></nav><div class="odoc-content"><h2 id="library-fpath-base-tests.fpath_base_test"><a href="#library-fpath-base-tests.fpath_base_test" class="anchor"></a>Library fpath-base-tests.fpath_base_test</h2><p>The entry point of this library is the module: <a href="Fpath_base_test/index.html"><code>Fpath_base_test</code></a>.</p><h2 id="library-fpath-base-tests.fpath_sexp0_test"><a href="#library-fpath-base-tests.fpath_sexp0_test" class="anchor"></a>Library fpath-base-tests.fpath_sexp0_test</h2><p>The entry point of this library is the module: <a href="Fpath_sexp0_test/index.html"><code>Fpath_sexp0_test</code></a>.</p></div></body></html>
2 changes: 1 addition & 1 deletion fpath-base/Fpath_base/Absolute_path/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion fpath-base/Fpath_base/File_name/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion fpath-base/Fpath_base/Fpath/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion fpath-base/Fpath_base/Relative_path/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion fpath-base/Fpath_base/index.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fpath_base (fpath-base.Fpath_base)</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><script>let base_url = '../../';
let search_urls = ['../db.js','../../sherlodoc.js'];
</script><script src="../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">fpath-base</a> &#x00BB; Fpath_base</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Fpath_base</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Fpath"><a href="#module-Fpath" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Fpath/index.html">Fpath</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Absolute_path"><a href="#module-Absolute_path" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Absolute_path/index.html">Absolute_path</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Relative_path"><a href="#module-Relative_path" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Relative_path/index.html">Relative_path</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-File_name"><a href="#module-File_name" class="anchor"></a><code><span><span class="keyword">module</span> <a href="File_name/index.html">File_name</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Basename of a File Path</p></div></div></div></body></html>
</script><script src="../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../index.html">fpath-base</a> &#x00BB; Fpath_base</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Fpath_base</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Fpath"><a href="#module-Fpath" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Fpath/index.html">Fpath</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Absolute_path"><a href="#module-Absolute_path" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Absolute_path/index.html">Absolute_path</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Relative_path"><a href="#module-Relative_path" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Relative_path/index.html">Relative_path</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-File_name"><a href="#module-File_name" class="anchor"></a><code><span><span class="keyword">module</span> <a href="File_name/index.html">File_name</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
2 changes: 1 addition & 1 deletion fpath-base/db.js

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions fpath-sexp0/Fpath_sexp0/Absolute_path/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Absolute_path (fpath-sexp0.Fpath_sexp0.Absolute_path)</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><script>let base_url = '../../../';
let search_urls = ['../../db.js','../../../sherlodoc.js'];
</script><script src="../../../odoc.support/odoc_search.js" defer="defer"></script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">fpath-sexp0</a> &#x00BB; <a href="../index.html">Fpath_sexp0</a> &#x00BB; Absolute_path</nav><div class="odoc-search"><div class="search-inner"><input class="search-bar" placeholder="🔎 Search..."/><div class="search-snake"></div><div class="search-result"></div></div></div><header class="odoc-preamble"><h1>Module <code><span>Fpath_sexp0.Absolute_path</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="xref-unresolved">Fpath</span>.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sexp_of_t"><a href="#val-sexp_of_t" class="anchor"></a><code><span><span class="keyword">val</span> sexp_of_t : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Sexplib0</span>.Sexp.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_fpath"><a href="#val-to_fpath" class="anchor"></a><code><span><span class="keyword">val</span> to_fpath : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Fpath</span>.t</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 class="odoc-spec"><div class="spec value anchored" id="val-of_fpath"><a href="#val-of_fpath" class="anchor"></a><code><span><span class="keyword">val</span> of_fpath : <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> option</span></span></code></div><div class="spec-doc"><p><code>of_fpath p</code> returns a normalized of <code>p</code> classified as an absolute path. Returns <code>None</code> if <code>p</code> is not an absolute path.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">&#45;&gt;</span></span> <span><span>(<a href="#type-t">t</a>, <span>[ <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.Result.t</span></span></code></div><div class="spec-doc"><p>This is a convenient wrapper to compose <a href="../Fpath/index.html#val-of_string"><code>Fpath.of_string</code></a> and <a href="#val-of_fpath"><code>of_fpath</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-v"><a href="#val-v" class="anchor"></a><code><span><span class="keyword">val</span> v : <span>string <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>v str</code> returns a <code>t</code> or raises <code>Invalid_argument</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-root"><a href="#val-root" class="anchor"></a><code><span><span class="keyword">val</span> root : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>The root path <code>&quot;/&quot;</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-append"><a href="#val-append" class="anchor"></a><code><span><span class="keyword">val</span> append : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Fpath</span>.t <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-extend"><a href="#val-extend" class="anchor"></a><code><span><span class="keyword">val</span> extend : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../File_name/index.html#type-t">File_name.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-parent"><a href="#val-parent" class="anchor"></a><code><span><span class="keyword">val</span> parent : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chop_prefix"><a href="#val-chop_prefix" class="anchor"></a><code><span><span class="keyword">val</span> chop_prefix : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">prefix</span>:<a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Fpath</span>.t option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chop_suffix"><a href="#val-chop_suffix" class="anchor"></a><code><span><span class="keyword">val</span> chop_suffix : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">suffix</span>:<span class="xref-unresolved">Fpath</span>.t <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_dir_path"><a href="#val-is_dir_path" class="anchor"></a><code><span><span class="keyword">val</span> is_dir_path : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_dir_path"><a href="#val-to_dir_path" class="anchor"></a><code><span><span class="keyword">val</span> to_dir_path : <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-relativize"><a href="#val-relativize" class="anchor"></a><code><span><span class="keyword">val</span> relativize : <span><span class="label">root</span>:<a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Converts a Path.t to an Absolute_path.t:</p><ul><li>If the path is already absolute, that's the answer.</li><li>If the path is relative, it is made absolute by appending it to <code>root</code>.</li></ul></div></div></div></body></html>
Loading

0 comments on commit 59b2a21

Please sign in to comment.