Add generating API for transactron. (#469)

kuznia-rdzeni · Oct 7, 2023 · c74ed41 · c74ed41
1 parent a31accd
commit c74ed41
Show file tree

Hide file tree

Showing 42 changed files with 2,899 additions and 76 deletions.
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/modules-coreblocks.doctree b/.doctrees/modules-coreblocks.doctree
diff --git a/.doctrees/modules-transactron.doctree b/.doctrees/modules-transactron.doctree
diff --git a/.doctrees/transactron.doctree b/.doctrees/transactron.doctree
diff --git a/Assumptions.html b/Assumptions.html
@@ -104,7 +104,7 @@ <h1>List of assumptions made during development<a class="headerlink" href="#list
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/Current_graph.html b/Current_graph.html
@@ -517,7 +517,7 @@ <h1>Full transaction-method graph<a class="headerlink" href="#full-transaction-m
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/Development_environment.html b/Development_environment.html
@@ -178,7 +178,7 @@ <h3>build_docs.sh<a class="headerlink" href="#build-docs-sh" title="Permalink to
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/Home.html b/Home.html
@@ -129,7 +129,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/Problem-checklist.html b/Problem-checklist.html
@@ -105,7 +105,7 @@ <h1>Problem checklist<a class="headerlink" href="#problem-checklist" title="Perm
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/Transactions.html b/Transactions.html
@@ -267,7 +267,7 @@ <h3>Transaction and method nesting<a class="headerlink" href="#transaction-and-m
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/_sources/api.md.txt b/_sources/api.md.txt
@@ -1,5 +1,6 @@
 # API
 
 ```{eval-rst}
-.. include:: modules.rst
-```
+.. include:: modules-coreblocks.rst
+.. include:: modules-transactron.rst
+```
diff --git a/_sources/modules-coreblocks.rst.txt b/_sources/modules-coreblocks.rst.txt
@@ -0,0 +1,7 @@
+coreblocks
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   coreblocks
diff --git a/_sources/modules-transactron.rst.txt b/_sources/modules-transactron.rst.txt
@@ -0,0 +1,7 @@
+transactron
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   transactron
diff --git a/_sources/transactron.rst.txt b/_sources/transactron.rst.txt
@@ -0,0 +1,45 @@
+transactron package
+===================
+
+Submodules
+----------
+
+transactron.core module
+-----------------------
+
+.. automodule:: transactron.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+transactron.graph module
+------------------------
+
+.. automodule:: transactron.graph
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+transactron.lib module
+----------------------
+
+.. automodule:: transactron.lib
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+transactron.tracing module
+--------------------------
+
+.. automodule:: transactron.tracing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: transactron
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/api.html b/api.html
@@ -58,6 +58,10 @@
 <li class="toctree-l3"><a class="reference internal" href="coreblocks.html">coreblocks package</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="#transactron">transactron</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="transactron.html">transactron package</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@@ -187,6 +191,22 @@ <h2>coreblocks<a class="headerlink" href="#coreblocks" title="Permalink to this
 </ul>
 </div>
 </div>
+<div class="section" id="transactron">
+<h2>transactron<a class="headerlink" href="#transactron" title="Permalink to this heading"></a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="transactron.html">transactron package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="transactron.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transactron.html#module-transactron.core">transactron.core module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transactron.html#module-transactron.graph">transactron.graph module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transactron.html#module-transactron.lib">transactron.lib module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transactron.html#module-transactron.tracing">transactron.tracing module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="transactron.html#module-transactron">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
 </div>
 
 
@@ -201,7 +221,7 @@ <h2>coreblocks<a class="headerlink" href="#coreblocks" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/auto_graph.html b/auto_graph.html
@@ -509,7 +509,7 @@
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/components/icache.html b/components/icache.html
@@ -131,7 +131,7 @@ <h2>Address mapping example<a class="headerlink" href="#address-mapping-example"
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/coreblocks.frontend.html b/coreblocks.frontend.html
@@ -98,7 +98,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 a combinatorial manner.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="coreblocks.frontend.decode.Decode.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gen_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="coreblocks.params.html#coreblocks.params.genparams.GenParams" title="coreblocks.params.genparams.GenParams"><span class="pre">GenParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">push_decoded</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Method</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#coreblocks.frontend.decode.Decode.__init__" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gen_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="coreblocks.params.html#coreblocks.params.genparams.GenParams" title="coreblocks.params.genparams.GenParams"><span class="pre">GenParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">push_decoded</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#coreblocks.frontend.decode.Decode.__init__" title="Permalink to this definition"></a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><dl class="simple">
@@ -203,7 +203,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 after each fetch.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="coreblocks.frontend.fetch.Fetch.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gen_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="coreblocks.params.html#coreblocks.params.genparams.GenParams" title="coreblocks.params.genparams.GenParams"><span class="pre">GenParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">icache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#coreblocks.frontend.icache.ICacheInterface" title="coreblocks.frontend.icache.ICacheInterface"><span class="pre">ICacheInterface</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cont</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Method</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#coreblocks.frontend.fetch.Fetch.__init__" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gen_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="coreblocks.params.html#coreblocks.params.genparams.GenParams" title="coreblocks.params.genparams.GenParams"><span class="pre">GenParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">icache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#coreblocks.frontend.icache.ICacheInterface" title="coreblocks.frontend.icache.ICacheInterface"><span class="pre">ICacheInterface</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cont</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#coreblocks.frontend.fetch.Fetch.__init__" title="Permalink to this definition"></a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><dl class="simple">
@@ -229,7 +229,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>Simple fetch unit that works with unaligned and RVC instructions.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="coreblocks.frontend.fetch.UnalignedFetch.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gen_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="coreblocks.params.html#coreblocks.params.genparams.GenParams" title="coreblocks.params.genparams.GenParams"><span class="pre">GenParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">icache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#coreblocks.frontend.icache.ICacheInterface" title="coreblocks.frontend.icache.ICacheInterface"><span class="pre">ICacheInterface</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cont</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Method</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#coreblocks.frontend.fetch.UnalignedFetch.__init__" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gen_params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="coreblocks.params.html#coreblocks.params.genparams.GenParams" title="coreblocks.params.genparams.GenParams"><span class="pre">GenParams</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">icache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#coreblocks.frontend.icache.ICacheInterface" title="coreblocks.frontend.icache.ICacheInterface"><span class="pre">ICacheInterface</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cont</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#coreblocks.frontend.fetch.UnalignedFetch.__init__" title="Permalink to this definition"></a></dt>
 <dd><dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><dl class="simple">
@@ -331,17 +331,17 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="coreblocks.frontend.icache.ICacheInterface.accept_res">
-<span class="sig-name descname"><span class="pre">accept_res</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Method</span></em><a class="headerlink" href="#coreblocks.frontend.icache.ICacheInterface.accept_res" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">accept_res</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></em><a class="headerlink" href="#coreblocks.frontend.icache.ICacheInterface.accept_res" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="coreblocks.frontend.icache.ICacheInterface.flush">
-<span class="sig-name descname"><span class="pre">flush</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Method</span></em><a class="headerlink" href="#coreblocks.frontend.icache.ICacheInterface.flush" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">flush</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></em><a class="headerlink" href="#coreblocks.frontend.icache.ICacheInterface.flush" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="coreblocks.frontend.icache.ICacheInterface.issue_req">
-<span class="sig-name descname"><span class="pre">issue_req</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Method</span></em><a class="headerlink" href="#coreblocks.frontend.icache.ICacheInterface.issue_req" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">issue_req</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="transactron.html#transactron.core.Method" title="transactron.core.Method"><span class="pre">Method</span></a></em><a class="headerlink" href="#coreblocks.frontend.icache.ICacheInterface.issue_req" title="Permalink to this definition"></a></dt>
 <dd></dd></dl>
 
 </dd></dl>
@@ -404,7 +404,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/coreblocks.fu.html b/coreblocks.fu.html
@@ -796,7 +796,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/coreblocks.fu.unsigned_multiplication.html b/coreblocks.fu.unsigned_multiplication.html
@@ -237,7 +237,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>
 

diff --git a/coreblocks.html b/coreblocks.html
@@ -218,7 +218,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
   <div role="contentinfo">
     <p>&#169; Copyright Kuźnia Rdzeni, 2023.
-      <span class="lastupdated">Last updated on 09:14 2023-10-06.
+      <span class="lastupdated">Last updated on 10:23 2023-10-07.
       </span></p>
   </div>