Generate HTML documentation with LDoc

master
Jordan Irwin 2017-08-15 21:19:32 -07:00
parent 5ac1051911
commit c9d95f121c
6 changed files with 808 additions and 0 deletions

74
docs/reference/index.html Normal file
View File

@ -0,0 +1,74 @@
<!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>Glass</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>Glass Mod for Minetest mods</h1>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="modules/crafting.html">crafting</a></li>
<li><a href="modules/functions.html">functions</a></li>
<li><a href="modules/init.html">init</a></li>
<li><a href="modules/nodes.html">nodes</a></li>
</ul>
</div>
<div id="content">
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/crafting.html">crafting</a></td>
<td class="summary">Glass craft recipes.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/functions.html">functions</a></td>
<td class="summary">Glass functions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/init.html">init</a></td>
<td class="summary">Glass initialization script.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/nodes.html">nodes</a></td>
<td class="summary">Glass nodes.</td>
</tr>
</table>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/antum">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2017-08-15 21:17:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

303
docs/reference/ldoc.css Normal file
View File

@ -0,0 +1,303 @@
/* BEGIN RESET
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.com/yui/license.html
version: 2.8.2r1
*/
html {
color: #000;
background: #FFF;
}
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
margin: 0;
padding: 0;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
fieldset,img {
border: 0;
}
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
font-style: inherit;
font-weight: inherit;
}
del,ins {
text-decoration: none;
}
li {
margin-left: 20px;
}
caption,th {
text-align: left;
}
h1,h2,h3,h4,h5,h6 {
font-size: 100%;
font-weight: bold;
}
q:before,q:after {
content: '';
}
abbr,acronym {
border: 0;
font-variant: normal;
}
sup {
vertical-align: baseline;
}
sub {
vertical-align: baseline;
}
legend {
color: #000;
}
input,button,textarea,select,optgroup,option {
font-family: inherit;
font-size: inherit;
font-style: inherit;
font-weight: inherit;
}
input,button,textarea,select {*font-size:100%;
}
/* END RESET */
body {
margin-left: 1em;
margin-right: 1em;
font-family: arial, helvetica, geneva, sans-serif;
background-color: #ffffff; margin: 0px;
}
code, tt { font-family: monospace; font-size: 1.1em; }
span.parameter { font-family:monospace; }
span.parameter:after { content:":"; }
span.types:before { content:"("; }
span.types:after { content:")"; }
.type { font-weight: bold; font-style:italic }
body, p, td, th { font-size: .95em; line-height: 1.2em;}
p, ul { margin: 10px 0 0 0px;}
strong { font-weight: bold;}
em { font-style: italic;}
h1 {
font-size: 1.5em;
margin: 20px 0 20px 0;
}
h2, h3, h4 { margin: 15px 0 10px 0; }
h2 { font-size: 1.25em; }
h3 { font-size: 1.15em; }
h4 { font-size: 1.06em; }
a:link { font-weight: bold; color: #004080; text-decoration: none; }
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
a:link:hover { text-decoration: underline; }
hr {
color:#cccccc;
background: #00007f;
height: 1px;
}
blockquote { margin-left: 3em; }
ul { list-style-type: disc; }
p.name {
font-family: "Andale Mono", monospace;
padding-top: 1em;
}
pre {
background-color: rgb(245, 245, 245);
border: 1px solid #C0C0C0; /* silver */
padding: 10px;
margin: 10px 0 10px 0;
overflow: auto;
font-family: "Andale Mono", monospace;
}
pre.example {
font-size: .85em;
}
table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
#container {
margin-left: 1em;
margin-right: 1em;
background-color: #f0f0f0;
}
#product {
text-align: center;
border-bottom: 1px solid #cccccc;
background-color: #ffffff;
}
#product big {
font-size: 2em;
}
#main {
background-color: #f0f0f0;
border-left: 2px solid #cccccc;
}
#navigation {
float: left;
width: 14em;
vertical-align: top;
background-color: #f0f0f0;
overflow: visible;
}
#navigation h2 {
background-color:#e7e7e7;
font-size:1.1em;
color:#000000;
text-align: left;
padding:0.2em;
border-top:1px solid #dddddd;
border-bottom:1px solid #dddddd;
}
#navigation ul
{
font-size:1em;
list-style-type: none;
margin: 1px 1px 10px 1px;
}
#navigation li {
text-indent: -1em;
display: block;
margin: 3px 0px 0px 22px;
}
#navigation li li a {
margin: 0px 3px 0px -1em;
}
#content {
margin-left: 14em;
padding: 1em;
width: 700px;
border-left: 2px solid #cccccc;
border-right: 2px solid #cccccc;
background-color: #ffffff;
}
#about {
clear: both;
padding: 5px;
border-top: 2px solid #cccccc;
background-color: #ffffff;
}
@media print {
body {
font: 12pt "Times New Roman", "TimeNR", Times, serif;
}
a { font-weight: bold; color: #004080; text-decoration: underline; }
#main {
background-color: #ffffff;
border-left: 0px;
}
#container {
margin-left: 2%;
margin-right: 2%;
background-color: #ffffff;
}
#content {
padding: 1em;
background-color: #ffffff;
}
#navigation {
display: none;
}
pre.example {
font-family: "Andale Mono", monospace;
font-size: 10pt;
page-break-inside: avoid;
}
}
table.module_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.module_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.module_list td.summary { width: 100%; }
table.function_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.function_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.function_list td.summary { width: 100%; }
ul.nowrap {
overflow:auto;
white-space:nowrap;
}
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
dl.table h3, dl.function h3 {font-size: .95em;}
/* stop sublists from having initial vertical space */
ul ul { margin-top: 0px; }
ol ul { margin-top: 0px; }
ol ol { margin-top: 0px; }
ul ol { margin-top: 0px; }
/* make the target distinct; helps when we're navigating to a function */
a:target + * {
background-color: #FF9;
}
/* styles for prettification of source */
pre .comment { color: #558817; }
pre .constant { color: #a8660d; }
pre .escape { color: #844631; }
pre .keyword { color: #aa5050; font-weight: bold; }
pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #8080ff; }
pre .number { color: #f8660d; }
pre .operator { color: #2239a8; font-weight: bold; }
pre .preprocessor, pre .prepro { color: #a33243; }
pre .global { color: #800080; }
pre .user-keyword { color: #800080; }
pre .prompt { color: #558817; }
pre .url { color: #272fc2; text-decoration: underline; }

View File

@ -0,0 +1,138 @@
<!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>Glass</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>Glass Mod for Minetest mods</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Cooking_Recipes">Cooking Recipes </a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><strong>crafting</strong></li>
<li><a href="../modules/functions.html">functions</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/nodes.html">nodes</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>crafting</code></h1>
<p>Glass craft recipes.</p>
<p></p>
<h2><a href="#Cooking_Recipes">Cooking Recipes </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#glass:plain">glass:plain</a></td>
<td class="summary">Glass recipe.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#glass:obsidian">glass:obsidian</a></td>
<td class="summary">Obsidian glass recipe.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Cooking_Recipes"></a>Cooking Recipes </h2>
<dl class="function">
<dt>
<a name = "glass:plain"></a>
<strong>glass:plain</strong>
</dt>
<dd>
Glass recipe.
<h3>Recipe type:</h3>
<ul>
cooking
</ul>
<h3>Output:</h3>
<ul>
1
</ul>
<h3>Input:</h3>
<ul>
group:sand
</ul>
</dd>
<dt>
<a name = "glass:obsidian"></a>
<strong>glass:obsidian</strong>
</dt>
<dd>
Obsidian glass recipe.
<h3>Recipe type:</h3>
<ul>
cooking
</ul>
<h3>Output:</h3>
<ul>
1
</ul>
<h3>Input:</h3>
<ul>
default:obsidian_shard
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/antum">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2017-08-15 21:17:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,106 @@
<!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>Glass</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>Glass Mod for Minetest mods</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Sounds">Sounds </a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/crafting.html">crafting</a></li>
<li><strong>functions</strong></li>
<li><a href="../modules/init.html">init</a></li>
<li><a href="../modules/nodes.html">nodes</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>functions</code></h1>
<p>Glass functions.</p>
<p></p>
<h2><a href="#Sounds">Sounds </a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#glass.node_sounds">glass.node_sounds (table)</a></td>
<td class="summary">Retrieves sounds for glass nodes.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Sounds"></a>Sounds </h2>
<dl class="function">
<dt>
<a name = "glass.node_sounds"></a>
<strong>glass.node_sounds (table)</strong>
</dt>
<dd>
Retrieves sounds for glass nodes.
</ul>
</ul>
</ul>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">table</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.5">table</a></span>
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/antum">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2017-08-15 21:17:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,67 @@
<!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>Glass</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>Glass Mod for Minetest mods</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/crafting.html">crafting</a></li>
<li><a href="../modules/functions.html">functions</a></li>
<li><strong>init</strong></li>
<li><a href="../modules/nodes.html">nodes</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>init</code></h1>
<p>Glass initialization script.</p>
<p></p>
<br/>
<br/>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/antum">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2017-08-15 21:17:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@ -0,0 +1,120 @@
<!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>Glass</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>Glass Mod for Minetest mods</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Nodes">Nodes</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/crafting.html">crafting</a></li>
<li><a href="../modules/functions.html">functions</a></li>
<li><a href="../modules/init.html">init</a></li>
<li><strong>nodes</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>nodes</code></h1>
<p>Glass nodes.</p>
<p></p>
<h2><a href="#Nodes">Nodes</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#glass:plain">glass:plain</a></td>
<td class="summary">Plain glass.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#glass:obsidian">glass:obsidian</a></td>
<td class="summary">Obsidian glass.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Nodes"></a>Nodes</h2>
<dl class="function">
<dt>
<a name = "glass:plain"></a>
<strong>glass:plain</strong>
</dt>
<dd>
Plain glass.
</ul>
</ul>
</ul>
</dd>
<dt>
<a name = "glass:obsidian"></a>
<strong>glass:obsidian</strong>
</dt>
<dd>
Obsidian glass.
</ul>
</ul>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/antum">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2017-08-15 21:17:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>