Skip to content

Commit

Permalink
Re-generate documentation for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
@florianschanda
florianschanda committed Jun 12, 2023
1 parent 2c14694 commit 9ab4f85
Show file tree
Hide file tree
Showing 14 changed files with 355 additions and 249 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a423dee0b37bf8aeb4429d15836b6981
config: 111e85c97fd3a6010d134b07b951e6d5
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/manual/ast.doctree
View file
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/_sources/manual/ast.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Entities
Miscellaneous
-------------

.. autoclass:: trlc.ast.Compilation_Unit

.. autoclass:: trlc.ast.Check_Block

.. autoclass:: trlc.ast.Check

.. autoclass:: trlc.ast.Separator
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.1.4',
VERSION: '1.1.5',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
476 changes: 252 additions & 224 deletions docs/ast_hierarchy.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 9 additions & 5 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; TRLC 1.1.4 documentation</title>
<title>Index &#8212; TRLC 1.1.5 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />

Expand All @@ -22,7 +22,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down Expand Up @@ -107,12 +107,16 @@ <h2 id="C">C</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manual/ast.html#trlc.ast.Check">Check (class in trlc.ast)</a>
</li>
<li><a href="manual/ast.html#trlc.ast.Composite_Component">Composite_Component (class in trlc.ast)</a>
<li><a href="manual/ast.html#trlc.ast.Check_Block">Check_Block (class in trlc.ast)</a>
</li>
<li><a href="manual/ast.html#trlc.ast.Composite_Type">Composite_Type (class in trlc.ast)</a>
<li><a href="manual/ast.html#trlc.ast.Compilation_Unit">Compilation_Unit (class in trlc.ast)</a>
</li>
<li><a href="manual/ast.html#trlc.ast.Composite_Component">Composite_Component (class in trlc.ast)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manual/ast.html#trlc.ast.Composite_Type">Composite_Type (class in trlc.ast)</a>
</li>
<li><a href="manual/ast.html#trlc.ast.Concrete_Type">Concrete_Type (class in trlc.ast)</a>
</li>
<li><a href="manual/ast.html#trlc.ast.Conditional_Expression">Conditional_Expression (class in trlc.ast)</a>
Expand Down Expand Up @@ -392,7 +396,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>TRLC Python API &#8212; TRLC 1.1.4 documentation</title>
<title>TRLC Python API &#8212; TRLC 1.1.5 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />

Expand All @@ -27,7 +27,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="manual/infrastructure.html" title="Infrastructure"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">TRLC Python API</a></li>
</ul>
</div>
Expand Down Expand Up @@ -140,7 +140,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="manual/infrastructure.html" title="Infrastructure"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">TRLC Python API</a></li>
</ul>
</div>
Expand Down
80 changes: 75 additions & 5 deletions docs/manual/ast.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>AST &#8212; TRLC 1.1.4 documentation</title>
<title>AST &#8212; TRLC 1.1.5 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />

Expand All @@ -27,7 +27,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="errors.html" title="Error handling and reporting"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">AST</a></li>
</ul>
</div>
Expand Down Expand Up @@ -147,14 +147,20 @@ <h2>Entities<a class="headerlink" href="#entities" title="Permalink to this head

<dl class="py class">
<dt class="sig sig-object py" id="trlc.ast.Package">
<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">Package</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">builtin_stab</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Package" title="Permalink to this definition"></a></dt>
<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">Package</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">builtin_stab</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">declared_late</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Package" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#trlc.ast.Entity" title="trlc.ast.Entity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Entity</span></code></a></p>
<p>Packages.</p>
<p>A package is declared when it is first encountered (in either a
rsl or trlc file). A package contains all symbols declared in it,
both types and record objects. A package is not associated with
just a single file, it can be spread over multiple files.</p>
<dl class="field-list simple">
<dt class="field-odd">Attribute declared_late<span class="colon">:</span></dt>
<dd class="field-odd"><p>indicates if this package is declared in a trlc file</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">Attribute symbols<span class="colon">:</span></dt>
<dd class="field-odd"><p>symbol table of the package</p>
</dd>
Expand Down Expand Up @@ -365,6 +371,56 @@ <h2>Entities<a class="headerlink" href="#entities" title="Permalink to this head
</section>
<section id="miscellaneous">
<h2>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="trlc.ast.Compilation_Unit">
<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">Compilation_Unit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Compilation_Unit" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#trlc.ast.Node" title="trlc.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a></p>
<p>Special node to represent the concrete file structure</p>
<dl class="field-list simple">
<dt class="field-odd">Attribute package<span class="colon">:</span></dt>
<dd class="field-odd"><p>the main package this file declares or contributes to</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#trlc.ast.Package" title="trlc.ast.Package">Package</a></p>
</dd>
<dt class="field-odd">Attribute imports<span class="colon">:</span></dt>
<dd class="field-odd"><p>package imported by this file</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[<a class="reference internal" href="#trlc.ast.Package" title="trlc.ast.Package">Package</a>]</p>
</dd>
<dt class="field-odd">Attribute items<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[<a class="reference internal" href="#trlc.ast.Node" title="trlc.ast.Node">Node</a>]</p>
</dd>
</dl>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="trlc.ast.Check_Block">
<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">Check_Block</span></span><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Check_Block" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#trlc.ast.Node" title="trlc.ast.Node"><code class="xref py py-class docutils literal notranslate"><span class="pre">Node</span></code></a></p>
<p>Node representing check blocks</p>
<p>Semantically this has no meaning, but it’s nice to have some kind
of similar representation to how it’s in the file.</p>
<dl class="field-list simple">
<dt class="field-odd">Attribute n_typ<span class="colon">:</span></dt>
<dd class="field-odd"><p>composite type for which the checks apply</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#trlc.ast.Composite_Type" title="trlc.ast.Composite_Type">Composite_Type</a></p>
</dd>
<dt class="field-odd">Attribute checks<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of checks</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[<a class="reference internal" href="#trlc.ast.Check" title="trlc.ast.Check">Check</a>]</p>
</dd>
</dl>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="trlc.ast.Check">
<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">Check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_expr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_anchor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">severity</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t_message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Check" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -478,7 +534,7 @@ <h2>Types<a class="headerlink" href="#types" title="Permalink to this heading">

<dl class="py class">
<dt class="sig sig-object py" id="trlc.ast.Array_Type">
<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">Array_Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">location</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lower_bound</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upper_bound</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Array_Type" title="Permalink to this definition"></a></dt>
<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">Array_Type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">location</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">element_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loc_lower</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lower_bound</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loc_upper</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upper_bound</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#trlc.ast.Array_Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#trlc.ast.Type" title="trlc.ast.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a></p>
<p>Anonymous array type.</p>
<p>These are declared implicitly for each record component that has
Expand All @@ -494,12 +550,24 @@ <h2>Types<a class="headerlink" href="#types" title="Permalink to this heading">
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>int</p>
</dd>
<dt class="field-odd">Attribute loc_lower<span class="colon">:</span></dt>
<dd class="field-odd"><p>text location of the lower bound indicator</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="errors.html#trlc.errors.Location" title="trlc.errors.Location">Location</a></p>
</dd>
<dt class="field-odd">Attribute upper_bound<span class="colon">:</span></dt>
<dd class="field-odd"><p>maximum number of elements (or None)</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>int</p>
</dd>
<dt class="field-odd">Attribute loc_upper<span class="colon">:</span></dt>
<dd class="field-odd"><p>text location of the upper bound indicator</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="errors.html#trlc.errors.Location" title="trlc.errors.Location">Location</a></p>
</dd>
<dt class="field-odd">Attribute element_type<span class="colon">:</span></dt>
<dd class="field-odd"><p>type of the array elements</p>
</dd>
Expand Down Expand Up @@ -1536,6 +1604,8 @@ <h3><a href="../index.html">Table of Contents</a></h3>
</ul>
</li>
<li><a class="reference internal" href="#miscellaneous">Miscellaneous</a><ul>
<li><a class="reference internal" href="#trlc.ast.Compilation_Unit"><code class="docutils literal notranslate"><span class="pre">Compilation_Unit</span></code></a></li>
<li><a class="reference internal" href="#trlc.ast.Check_Block"><code class="docutils literal notranslate"><span class="pre">Check_Block</span></code></a></li>
<li><a class="reference internal" href="#trlc.ast.Check"><code class="docutils literal notranslate"><span class="pre">Check</span></code></a></li>
<li><a class="reference internal" href="#trlc.ast.Separator"><code class="docutils literal notranslate"><span class="pre">Separator</span></code></a></li>
</ul>
Expand Down Expand Up @@ -1618,7 +1688,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="errors.html" title="Error handling and reporting"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">AST</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/errors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Error handling and reporting &#8212; TRLC 1.1.4 documentation</title>
<title>Error handling and reporting &#8212; TRLC 1.1.5 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />

Expand All @@ -31,7 +31,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="infrastructure.html" title="Infrastructure"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Error handling and reporting</a></li>
</ul>
</div>
Expand Down Expand Up @@ -252,7 +252,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="infrastructure.html" title="Infrastructure"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.4 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">TRLC 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Error handling and reporting</a></li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 9ab4f85

Please sign in to comment.