automated commit TP4 + Doc
This commit is contained in:
@@ -0,0 +1,7 @@
|
||||
Lib.Allocator module
|
||||
====================
|
||||
|
||||
.. automodule:: Lib.Allocator
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
Lib.Errors module
|
||||
=================
|
||||
|
||||
.. automodule:: Lib.Errors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
Lib.FunctionData module
|
||||
=======================
|
||||
|
||||
.. automodule:: Lib.FunctionData
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
Lib.LinearCode module
|
||||
=====================
|
||||
|
||||
.. automodule:: Lib.LinearCode
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
Lib.Operands module
|
||||
===================
|
||||
|
||||
.. automodule:: Lib.Operands
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
Lib.RiscV module
|
||||
================
|
||||
|
||||
.. automodule:: Lib.RiscV
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
Lib.Statement module
|
||||
====================
|
||||
|
||||
.. automodule:: Lib.Statement
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,24 @@
|
||||
Lib package
|
||||
===========
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
Lib.Allocator
|
||||
Lib.Errors
|
||||
Lib.FunctionData
|
||||
Lib.LinearCode
|
||||
Lib.Operands
|
||||
Lib.RiscV
|
||||
Lib.Statement
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: Lib
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@@ -0,0 +1,7 @@
|
||||
MiniC
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
Lib
|
||||
@@ -0,0 +1,54 @@
|
||||
.. MiniC documentation master file, created by
|
||||
sphinx-quickstart on Thu Feb 3 16:47:38 2022.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to MiniC's documentation!
|
||||
=================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:caption: Contents:
|
||||
|
||||
Base library - Errors <api/Lib.Errors>
|
||||
Base library - Statement <api/Lib.Statement>
|
||||
Base library - RISC-V instructions <api/Lib.RiscV>
|
||||
Base library - Operands <api/Lib.Operands>
|
||||
Base library - Function data <api/Lib.FunctionData>
|
||||
Linear intermediate representation <api/Lib.LinearCode>
|
||||
Temporary allocation <api/Lib.Allocator>
|
||||
|
||||
These pages document the various Python sources in the Lib/
|
||||
folder of MiniC. You should not have to edit them *at all*.
|
||||
|
||||
Base library
|
||||
------------
|
||||
|
||||
The :doc:`api/Lib.Statement` defines various classes that represent
|
||||
RISC-V assembly statements, such as labels or 3-address instructions.
|
||||
|
||||
We won't create objects of these classes directly very often.
|
||||
Instead, to easily create such statements for standard RISC-V assembly instructions
|
||||
and pseudo-instructions, we give you the :doc:`api/Lib.RiscV`.
|
||||
|
||||
RISC-V instructions take arguments of various kinds,
|
||||
as defined in the :doc:`api/Lib.Operands`.
|
||||
|
||||
Linear Intermediate representation
|
||||
----------------------------------
|
||||
|
||||
The :doc:`api/Lib.LinearCode` allows to work with assembly source code
|
||||
modeled as a list of statements.
|
||||
|
||||
Temporary allocation
|
||||
--------------------
|
||||
|
||||
Before implementing the all-in-memory allocator of lab 4a,
|
||||
you should understand the naive allocator in the :doc:`api/Lib.Allocator`.
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
Reference in New Issue
Block a user