Skip to content

Commit 0e9b9d0

Browse files
committedMay 8, 2023
Re-generate documentation for release.
1 parent f728685 commit 0e9b9d0

12 files changed

+46
-22
lines changed
 

‎docs/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 59a3f3a9d573da85ce4bc95a5c10d005
3+
config: c95d6f3086f118a3f7bc6943ce9ad6ec
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.doctrees/environment.pickle

5.29 KB
Binary file not shown.

‎docs/.doctrees/manual/ast.doctree

3.37 KB
Binary file not shown.

‎docs/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.1.2',
3+
VERSION: '1.1.3',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/genindex.html

+7-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &#8212; TRLC 1.1.2 documentation</title>
8+
<title>Index &#8212; TRLC 1.1.3 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111

@@ -22,7 +22,7 @@ <h3>Navigation</h3>
2222
<li class="right" style="margin-right: 10px">
2323
<a href="#" title="General Index"
2424
accesskey="I">index</a></li>
25-
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.2 documentation</a> &#187;</li>
25+
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.3 documentation</a> &#187;</li>
2626
<li class="nav-item nav-item-this"><a href="">Index</a></li>
2727
</ul>
2828
</div>
@@ -164,7 +164,11 @@ <h2 id="F">F</h2>
164164
</ul></td>
165165
<td style="width: 33%; vertical-align: top;"><ul>
166166
<li><a href="manual/ast.html#trlc.ast.Concrete_Type.fully_qualified_name">fully_qualified_name() (trlc.ast.Concrete_Type method)</a>
167+
168+
<ul>
169+
<li><a href="manual/ast.html#trlc.ast.Record_Object.fully_qualified_name">(trlc.ast.Record_Object method)</a>
167170
</li>
171+
</ul></li>
168172
</ul></td>
169173
</tr></table>
170174

@@ -388,7 +392,7 @@ <h3>Navigation</h3>
388392
<li class="right" style="margin-right: 10px">
389393
<a href="#" title="General Index"
390394
>index</a></li>
391-
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.2 documentation</a> &#187;</li>
395+
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.3 documentation</a> &#187;</li>
392396
<li class="nav-item nav-item-this"><a href="">Index</a></li>
393397
</ul>
394398
</div>

‎docs/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
88

9-
<title>TRLC Python API &#8212; TRLC 1.1.2 documentation</title>
9+
<title>TRLC Python API &#8212; TRLC 1.1.3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1212

@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="manual/infrastructure.html" title="Infrastructure"
2929
accesskey="N">next</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.2 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.3 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">TRLC Python API</a></li>
3232
</ul>
3333
</div>
@@ -140,7 +140,7 @@ <h3>Navigation</h3>
140140
<li class="right" >
141141
<a href="manual/infrastructure.html" title="Infrastructure"
142142
>next</a> |</li>
143-
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.2 documentation</a> &#187;</li>
143+
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.3 documentation</a> &#187;</li>
144144
<li class="nav-item nav-item-this"><a href="">TRLC Python API</a></li>
145145
</ul>
146146
</div>

‎docs/manual/ast.html

+24-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
88

9-
<title>AST &#8212; TRLC 1.1.2 documentation</title>
9+
<title>AST &#8212; TRLC 1.1.3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
1212

@@ -27,7 +27,7 @@ <h3>Navigation</h3>
2727
<li class="right" >
2828
<a href="errors.html" title="Error handling and reporting"
2929
accesskey="P">previous</a> |</li>
30-
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.2 documentation</a> &#187;</li>
30+
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.3 documentation</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">AST</a></li>
3232
</ul>
3333
</div>
@@ -287,7 +287,7 @@ <h2>Entities<a class="headerlink" href="#entities" title="Permalink to this head
287287

288288
<dl class="py class">
289289
<dt class="sig sig-object py" id="trlc.ast.Record_Object">
290-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">trlc.ast.</span></span><span class="sig-name descname"><span class="pre">Record_Object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_typ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">section</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Record_Object" title="Permalink to this definition"></a></dt>
290+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">trlc.ast.</span></span><span class="sig-name descname"><span class="pre">Record_Object</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_typ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">section</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_package</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Record_Object" title="Permalink to this definition"></a></dt>
291291
<dd><p>Bases: <a class="reference internal" href="#trlc.ast.Typed_Entity" title="trlc.ast.Typed_Entity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Typed_Entity</span></code></a></p>
292292
<p>A declared instance of a record type.</p>
293293
<p>This is going to be the bulk of all entities created by TRLC:</p>
@@ -315,6 +315,12 @@ <h2>Entities<a class="headerlink" href="#entities" title="Permalink to this head
315315
<dt class="field-even">Type<span class="colon">:</span></dt>
316316
<dd class="field-even"><p><a class="reference internal" href="#trlc.ast.Section" title="trlc.ast.Section">Section</a></p>
317317
</dd>
318+
<dt class="field-odd">Attribute n_package<span class="colon">:</span></dt>
319+
<dd class="field-odd"><p>The package in which this record is declared in</p>
320+
</dd>
321+
<dt class="field-even">Type<span class="colon">:</span></dt>
322+
<dd class="field-even"><p><a class="reference internal" href="#trlc.ast.Section" title="trlc.ast.Section">Section</a></p>
323+
</dd>
318324
</dl>
319325
<p>The actual type of expressions in the field attribute are limited
320326
to:</p>
@@ -326,6 +332,20 @@ <h2>Entities<a class="headerlink" href="#entities" title="Permalink to this head
326332
<li><p><a class="reference internal" href="#trlc.ast.Record_Reference" title="trlc.ast.Record_Reference"><code class="xref py py-class docutils literal notranslate"><span class="pre">Record_Reference</span></code></a></p></li>
327333
<li><p><a class="reference internal" href="#trlc.ast.Implicit_Null" title="trlc.ast.Implicit_Null"><code class="xref py py-class docutils literal notranslate"><span class="pre">Implicit_Null</span></code></a></p></li>
328334
</ul>
335+
<dl class="py method">
336+
<dt class="sig sig-object py" id="trlc.ast.Record_Object.fully_qualified_name">
337+
<span class="sig-name descname"><span class="pre">fully_qualified_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Record_Object.fully_qualified_name" title="Permalink to this definition"></a></dt>
338+
<dd><p>Return the FQN for this type (i.e. PACKAGE.NAME)</p>
339+
<dl class="field-list simple">
340+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
341+
<dd class="field-odd"><p>the object’s full name</p>
342+
</dd>
343+
<dt class="field-even">Return type<span class="colon">:</span></dt>
344+
<dd class="field-even"><p>str</p>
345+
</dd>
346+
</dl>
347+
</dd></dl>
348+
329349
<dl class="py method">
330350
<dt class="sig sig-object py" id="trlc.ast.Record_Object.to_python_dict">
331351
<span class="sig-name descname"><span class="pre">to_python_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Record_Object.to_python_dict" title="Permalink to this definition"></a></dt>
@@ -1598,7 +1618,7 @@ <h3>Navigation</h3>
15981618
<li class="right" >
15991619
<a href="errors.html" title="Error handling and reporting"
16001620
>previous</a> |</li>
1601-
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.2 documentation</a> &#187;</li>
1621+
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.3 documentation</a> &#187;</li>
16021622
<li class="nav-item nav-item-this"><a href="">AST</a></li>
16031623
</ul>
16041624
</div>

‎docs/manual/errors.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
88

9-
<title>Error handling and reporting &#8212; TRLC 1.1.2 documentation</title>
9+
<title>Error handling and reporting &#8212; TRLC 1.1.3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
1212

@@ -31,7 +31,7 @@ <h3>Navigation</h3>
3131
<li class="right" >
3232
<a href="infrastructure.html" title="Infrastructure"
3333
accesskey="P">previous</a> |</li>
34-
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.2 documentation</a> &#187;</li>
34+
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.3 documentation</a> &#187;</li>
3535
<li class="nav-item nav-item-this"><a href="">Error handling and reporting</a></li>
3636
</ul>
3737
</div>
@@ -252,7 +252,7 @@ <h3>Navigation</h3>
252252
<li class="right" >
253253
<a href="infrastructure.html" title="Infrastructure"
254254
>previous</a> |</li>
255-
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.2 documentation</a> &#187;</li>
255+
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.3 documentation</a> &#187;</li>
256256
<li class="nav-item nav-item-this"><a href="">Error handling and reporting</a></li>
257257
</ul>
258258
</div>

‎docs/manual/infrastructure.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
88

9-
<title>Infrastructure &#8212; TRLC 1.1.2 documentation</title>
9+
<title>Infrastructure &#8212; TRLC 1.1.3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
1212

@@ -31,7 +31,7 @@ <h3>Navigation</h3>
3131
<li class="right" >
3232
<a href="../index.html" title="TRLC Python API"
3333
accesskey="P">previous</a> |</li>
34-
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.2 documentation</a> &#187;</li>
34+
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.3 documentation</a> &#187;</li>
3535
<li class="nav-item nav-item-this"><a href="">Infrastructure</a></li>
3636
</ul>
3737
</div>
@@ -176,7 +176,7 @@ <h3>Navigation</h3>
176176
<li class="right" >
177177
<a href="../index.html" title="TRLC Python API"
178178
>previous</a> |</li>
179-
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.2 documentation</a> &#187;</li>
179+
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.3 documentation</a> &#187;</li>
180180
<li class="nav-item nav-item-this"><a href="">Infrastructure</a></li>
181181
</ul>
182182
</div>

‎docs/objects.inv

2 Bytes
Binary file not shown.

‎docs/search.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Search &#8212; TRLC 1.1.2 documentation</title>
8+
<title>Search &#8212; TRLC 1.1.3 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
1111

@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" style="margin-right: 10px">
2929
<a href="genindex.html" title="General Index"
3030
accesskey="I">index</a></li>
31-
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.3 documentation</a> &#187;</li>
3232
<li class="nav-item nav-item-this"><a href="">Search</a></li>
3333
</ul>
3434
</div>
@@ -93,7 +93,7 @@ <h3>Navigation</h3>
9393
<li class="right" style="margin-right: 10px">
9494
<a href="genindex.html" title="General Index"
9595
>index</a></li>
96-
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.2 documentation</a> &#187;</li>
96+
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.3 documentation</a> &#187;</li>
9797
<li class="nav-item nav-item-this"><a href="">Search</a></li>
9898
</ul>
9999
</div>

‎docs/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.