docs: auto generate docs

sontungexpt · Sep 23, 2023 · c242e1c · c242e1c
1 parent 9dfda52
commit c242e1c
Show file tree

Hide file tree

Showing 19 changed files with 1,827 additions and 11 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -100,7 +100,7 @@ <h2>Topics</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
-<i style="float:right;">Last updated 2023-09-23 15:49:33 </i>
+<i style="float:right;">Last updated 2023-09-23 16:15:02 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 
@@ -111,5 +111,10 @@ <h2>Topics</h2>
     let name = link.getAttribute("name");
     if (parent) parent.setAttribute("id", name);
   });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
 </script></body>
 </html>
diff --git a/docs/ldoc.css b/docs/ldoc.css
@@ -121,7 +121,7 @@ br {
 
 #main {
   display: flex;
-  flex-wrap: wrap;
+  /* flex-wrap: wrap; */
   min-height: 100vh;
 
   border: 1px solid var(--separator-color);
@@ -261,6 +261,7 @@ br {
 #content table td.name {
   color: var(--white-gray-color);
   font-weight: 600;
+  max-width: 500px;
 }
 
 #content dl {

diff --git a/docs/modules/lua.url-open.html b/docs/modules/lua.url-open.html
@@ -0,0 +1,148 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>url-open</title>
+    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>url-open</h1>
+
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><strong>lua.url-open</strong></li>
+  <li><a href="../modules/lua.url-open.modules.autocmd.html">lua.url-open.modules.autocmd</a></li>
+  <li><a href="../modules/lua.url-open.modules.commands.html">lua.url-open.modules.commands</a></li>
+  <li><a href="../modules/lua.url-open.modules.handlers.html">lua.url-open.modules.handlers</a></li>
+  <li><a href="../modules/lua.url-open.modules.highlight.html">lua.url-open.modules.highlight</a></li>
+  <li><a href="../modules/lua.url-open.modules.logger.html">lua.url-open.modules.logger</a></li>
+  <li><a href="../modules/lua.url-open.modules.options.html">lua.url-open.modules.options</a></li>
+  <li><a href="../modules/lua.url-open.modules.patterns.html">lua.url-open.modules.patterns</a></li>
+</ul>
+<h2>Topics</h2>
+<ul class="">
+  <li><a href="../topics/README.md.html">README</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>lua.url-open</code></h1>
+<p>The main entry point for the plugin to setup the plugin</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#Plugin.setup">Plugin.setup (user_opts)</a></td>
+	<td class="summary">Setup the plugin with the user options</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "Plugin.setup"></a>
+    <strong>Plugin.setup (user_opts)</strong>
+    </dt>
+    <dd>
+    Setup the plugin with the user options
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">user_opts</span>
+         table: The user options to setup the plugin with
+        </li>
+    </ul>
+
+
+
+    <h3>See also:</h3>
+    <ul>
+         <li><a href="../modules/lua.url-open.modules.commands.html"></a></li>
+         <li><a href="../modules/lua.url-open.modules.options.html"></a></li>
+    </ul>
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="global">require</span>(<span class="string">"url-open"</span>).<span class="function-name">setup</span>({})</pre>
+    </ul>
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
+<i style="float:right;">Last updated 2023-09-23 16:14:57 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script></body>
+</html>
diff --git a/docs/modules/lua.url-open.modules.autocmd.html b/docs/modules/lua.url-open.modules.autocmd.html
@@ -0,0 +1,150 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+    <title>url-open</title>
+    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+	<div id="product_logo"></div>
+	<div id="product_name"><big><b></b></big></div>
+	<div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>url-open</h1>
+
+
+<ul>
+  <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+  <li><a href="../modules/lua.url-open.html">lua.url-open</a></li>
+  <li><strong>lua.url-open.modules.autocmd</strong></li>
+  <li><a href="../modules/lua.url-open.modules.commands.html">lua.url-open.modules.commands</a></li>
+  <li><a href="../modules/lua.url-open.modules.handlers.html">lua.url-open.modules.handlers</a></li>
+  <li><a href="../modules/lua.url-open.modules.highlight.html">lua.url-open.modules.highlight</a></li>
+  <li><a href="../modules/lua.url-open.modules.logger.html">lua.url-open.modules.logger</a></li>
+  <li><a href="../modules/lua.url-open.modules.options.html">lua.url-open.modules.options</a></li>
+  <li><a href="../modules/lua.url-open.modules.patterns.html">lua.url-open.modules.patterns</a></li>
+</ul>
+<h2>Topics</h2>
+<ul class="">
+  <li><a href="../topics/README.md.html">README</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>lua.url-open.modules.autocmd</code></h1>
+<p>The module that handles the autocmds</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#setup">setup (user_opts)</a></td>
+	<td class="summary">Setup the autocmds</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "setup"></a>
+    <strong>setup (user_opts)</strong>
+    </dt>
+    <dd>
+    Setup the autocmds
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">user_opts</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
+         : The user options
+        </li>
+    </ul>
+
+
+
+    <h3>See also:</h3>
+    <ul>
+         <li><a href="../modules/lua.url-open.modules.commands.html"></a></li>
+         <li><a href="../modules/lua.url-open.modules.highlight.html#highlight_cursor_url">url-open.modules.highlight.highlight_cursor_url</a></li>
+         <li><a href="../modules/lua.url-open.modules.highlight.html#change_color_highlight">url-open.modules.highlight.change_color_highlight</a></li>
+    </ul>
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="global">require</span>(<span class="string">"url-open.modules.autocmd"</span>).<span class="function-name">setup</span>(opts)</pre>
+    </ul>
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
+<i style="float:right;">Last updated 2023-09-23 16:14:57 </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script>
+<script>
+  let links = document.querySelectorAll("a[name]");
+  links.forEach(function(link) {
+    let parent = link.parentElement;
+    let name = link.getAttribute("name");
+    if (parent) parent.setAttribute("id", name);
+  });
+  // remove nowrap attribute from td tag 
+  let tds = document.querySelectorAll("td");
+  tds.forEach(function(td) {
+    td.removeAttribute("nowrap");
+  });
+</script></body>
+</html>