Skip to content

Commit

Permalink
Make mkdocs, documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lovestaco committed Jul 22, 2023
1 parent 9c28a5c commit cf75f06
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
12 changes: 6 additions & 6 deletions docs/Lama2/docs/reference/parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ var DataInputType string
```

<a name="CustomPairMerge"></a>
## func [CustomPairMerge](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L29>)
## func [CustomPairMerge](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L30>)

```go
func CustomPairMerge(destination, source interface{}) interface{}
Expand Down Expand Up @@ -122,7 +122,7 @@ func (p *Lama2Parser) AnyType() (*gabs.Container, error)
AnyType is the top\-most element of a JSON structure It consists of Complex and Primitive Types

<a name="Lama2Parser.Boolean"></a>
### func \(\*Lama2Parser\) [Boolean](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L126>)
### func \(\*Lama2Parser\) [Boolean](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L127>)

```go
func (p *Lama2Parser) Boolean() (*gabs.Container, error)
Expand Down Expand Up @@ -320,7 +320,7 @@ func (p *Lama2Parser) Lama2File() (*gabs.Container, error)


<a name="Lama2Parser.List"></a>
### func \(\*Lama2Parser\) [List](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L69>)
### func \(\*Lama2Parser\) [List](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L70>)

```go
func (p *Lama2Parser) List() (*gabs.Container, error)
Expand All @@ -329,7 +329,7 @@ func (p *Lama2Parser) List() (*gabs.Container, error)
List is a slightly lenient version of standard JSON list. In Lama2 List, it is OK to have a trailing comma after the last element \(whereas in strict JSON, it is not OK to have trailing comma\)

<a name="Lama2Parser.Map"></a>
### func \(\*Lama2Parser\) [Map](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L37>)
### func \(\*Lama2Parser\) [Map](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L38>)

```go
func (p *Lama2Parser) Map() (*gabs.Container, error)
Expand All @@ -347,7 +347,7 @@ func (p *Lama2Parser) Multipart() (*gabs.Container, error)


<a name="Lama2Parser.Null"></a>
### func \(\*Lama2Parser\) [Null](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L142>)
### func \(\*Lama2Parser\) [Null](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L143>)

```go
func (p *Lama2Parser) Null() (*gabs.Container, error)
Expand All @@ -374,7 +374,7 @@ func (p *Lama2Parser) OneNine() (*gabs.Container, error)


<a name="Lama2Parser.Pair"></a>
### func \(\*Lama2Parser\) [Pair](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L105>)
### func \(\*Lama2Parser\) [Pair](<https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L106>)

```go
func (p *Lama2Parser) Pair() (*gabs.Container, error)
Expand Down
6 changes: 3 additions & 3 deletions docs/Lama2/docs/reference/preprocess.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func ExpandURL(block *gabs.Container, vm *goja.Runtime)


<a name="GetL2EnvVariables"></a>
## func [GetL2EnvVariables](<https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L170>)
## func [GetL2EnvVariables](<https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L169>)

```go
func GetL2EnvVariables(dir string) ([]byte, error)
Expand All @@ -79,7 +79,7 @@ func GetL2EnvVariables(dir string) ([]byte, error)


<a name="GetLamaFileAsString"></a>
## func [GetLamaFileAsString](<https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L201>)
## func [GetLamaFileAsString](<https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L200>)

```go
func GetLamaFileAsString(path string) string
Expand All @@ -88,7 +88,7 @@ func GetLamaFileAsString(path string) string


<a name="LamaFile"></a>
## func [LamaFile](<https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L215>)
## func [LamaFile](<https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L214>)

```go
func LamaFile(inputFile string) (string, string)
Expand Down
12 changes: 6 additions & 6 deletions docs/Lama2/site/reference/parser.html
Original file line number Diff line number Diff line change
Expand Up @@ -1194,7 +1194,7 @@ <h2 id="variables">Variables<a class="headerlink" href="#variables" title="Perma
<div class="highlight"><pre><span></span><code><span class="kd">var</span><span class="w"> </span><span class="nx">DataInputType</span><span class="w"> </span><span class="kt">string</span>
</code></pre></div>
<p><a name="CustomPairMerge"></a></p>
<h2 id="func-custompairmerge">func <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L29">CustomPairMerge</a><a class="headerlink" href="#func-custompairmerge" title="Permanent link">&para;</a></h2>
<h2 id="func-custompairmerge">func <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L30">CustomPairMerge</a><a class="headerlink" href="#func-custompairmerge" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="nx">CustomPairMerge</span><span class="p">(</span><span class="nx">destination</span><span class="p">,</span><span class="w"> </span><span class="nx">source</span><span class="w"> </span><span class="kd">interface</span><span class="p">{})</span><span class="w"> </span><span class="kd">interface</span><span class="p">{}</span>
</code></pre></div>
<p>CustomPairMerge uses a gabs feature to deal with merge conflicts. More here: https://github.com/HexmosTech/gabs/blob/master/gabs.go#L511</p>
Expand All @@ -1217,7 +1217,7 @@ <h3 id="func-lama2parser-anytype">func (*Lama2Parser) <a href="https://github.co
</code></pre></div>
<p>AnyType is the top-most element of a JSON structure It consists of Complex and Primitive Types</p>
<p><a name="Lama2Parser.Boolean"></a></p>
<h3 id="func-lama2parser-boolean">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L126">Boolean</a><a class="headerlink" href="#func-lama2parser-boolean" title="Permanent link">&para;</a></h3>
<h3 id="func-lama2parser-boolean">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L127">Boolean</a><a class="headerlink" href="#func-lama2parser-boolean" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">Boolean</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="Lama2Parser.ComplexType"></a></p>
Expand Down Expand Up @@ -1314,12 +1314,12 @@ <h3 id="func-lama2parser-lama2file">func (*Lama2Parser) <a href="https://github.
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">Lama2File</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="Lama2Parser.List"></a></p>
<h3 id="func-lama2parser-list">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L69">List</a><a class="headerlink" href="#func-lama2parser-list" title="Permanent link">&para;</a></h3>
<h3 id="func-lama2parser-list">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L70">List</a><a class="headerlink" href="#func-lama2parser-list" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">List</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p>List is a slightly lenient version of standard JSON list. In Lama2 List, it is OK to have a trailing comma after the last element (whereas in strict JSON, it is not OK to have trailing comma)</p>
<p><a name="Lama2Parser.Map"></a></p>
<h3 id="func-lama2parser-map">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L37">Map</a><a class="headerlink" href="#func-lama2parser-map" title="Permanent link">&para;</a></h3>
<h3 id="func-lama2parser-map">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L38">Map</a><a class="headerlink" href="#func-lama2parser-map" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">Map</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p>Map is a slightly lenient version of standard JSON map. In Lama2 Map, it is OK to have a trailing comma after the last element (whereas in strict JSON, it is not OK to have trailing comma)</p>
Expand All @@ -1328,7 +1328,7 @@ <h3 id="func-lama2parser-multipart">func (*Lama2Parser) <a href="https://github.
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">Multipart</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="Lama2Parser.Null"></a></p>
<h3 id="func-lama2parser-null">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L142">Null</a><a class="headerlink" href="#func-lama2parser-null" title="Permanent link">&para;</a></h3>
<h3 id="func-lama2parser-null">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L143">Null</a><a class="headerlink" href="#func-lama2parser-null" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">Null</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="Lama2Parser.Number"></a></p>
Expand All @@ -1341,7 +1341,7 @@ <h3 id="func-lama2parser-onenine">func (*Lama2Parser) <a href="https://github.co
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">OneNine</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="Lama2Parser.Pair"></a></p>
<h3 id="func-lama2parser-pair">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L105">Pair</a><a class="headerlink" href="#func-lama2parser-pair" title="Permanent link">&para;</a></h3>
<h3 id="func-lama2parser-pair">func (*Lama2Parser) <a href="https://github.com/HexmosTech/Lama2/blob/main/parser/jsonparser.go#L106">Pair</a><a class="headerlink" href="#func-lama2parser-pair" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="p">(</span><span class="nx">p</span><span class="w"> </span><span class="o">*</span><span class="nx">Lama2Parser</span><span class="p">)</span><span class="w"> </span><span class="nx">Pair</span><span class="p">()</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="Lama2Parser.PrimitiveType"></a></p>
Expand Down
6 changes: 3 additions & 3 deletions docs/Lama2/site/reference/preprocess.html
Original file line number Diff line number Diff line change
Expand Up @@ -823,15 +823,15 @@ <h2 id="func-expandurl">func <a href="https://github.com/HexmosTech/Lama2/blob/m
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="nx">ExpandURL</span><span class="p">(</span><span class="nx">block</span><span class="w"> </span><span class="o">*</span><span class="nx">gabs</span><span class="p">.</span><span class="nx">Container</span><span class="p">,</span><span class="w"> </span><span class="nx">vm</span><span class="w"> </span><span class="o">*</span><span class="nx">goja</span><span class="p">.</span><span class="nx">Runtime</span><span class="p">)</span>
</code></pre></div>
<p><a name="GetL2EnvVariables"></a></p>
<h2 id="func-getl2envvariables">func <a href="https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L170">GetL2EnvVariables</a><a class="headerlink" href="#func-getl2envvariables" title="Permanent link">&para;</a></h2>
<h2 id="func-getl2envvariables">func <a href="https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L169">GetL2EnvVariables</a><a class="headerlink" href="#func-getl2envvariables" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="nx">GetL2EnvVariables</span><span class="p">(</span><span class="nx">dir</span><span class="w"> </span><span class="kt">string</span><span class="p">)</span><span class="w"> </span><span class="p">([]</span><span class="kt">byte</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span>
</code></pre></div>
<p><a name="GetLamaFileAsString"></a></p>
<h2 id="func-getlamafileasstring">func <a href="https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L201">GetLamaFileAsString</a><a class="headerlink" href="#func-getlamafileasstring" title="Permanent link">&para;</a></h2>
<h2 id="func-getlamafileasstring">func <a href="https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L200">GetLamaFileAsString</a><a class="headerlink" href="#func-getlamafileasstring" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="nx">GetLamaFileAsString</span><span class="p">(</span><span class="nx">path</span><span class="w"> </span><span class="kt">string</span><span class="p">)</span><span class="w"> </span><span class="kt">string</span>
</code></pre></div>
<p><a name="LamaFile"></a></p>
<h2 id="func-lamafile">func <a href="https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L215">LamaFile</a><a class="headerlink" href="#func-lamafile" title="Permanent link">&para;</a></h2>
<h2 id="func-lamafile">func <a href="https://github.com/HexmosTech/Lama2/blob/main/preprocess/preprocess.go#L214">LamaFile</a><a class="headerlink" href="#func-lamafile" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="kd">func</span><span class="w"> </span><span class="nx">LamaFile</span><span class="p">(</span><span class="nx">inputFile</span><span class="w"> </span><span class="kt">string</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="kt">string</span><span class="p">)</span>
</code></pre></div>
<p>LamaFile takes in a path to an API file. It moves into the API file directory, reads the API contents, loads the `l2.env` file if available, and finally substitutes environment vars in the API contents Once done, it reverts back to the original directory, and returns the processed l2 file.</p>
Expand Down
Binary file modified docs/Lama2/site/sitemap.xml.gz
Binary file not shown.

0 comments on commit cf75f06

Please sign in to comment.