DOCS: amaranth integration, and further theory

daquintero · Aug 21, 2023 · 6c8154e · 6c8154e
1 parent 1dfc852
commit 6c8154e
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 18 deletions.
diff --git a/.../_static/img/examples/02_cocotb_simulation/example_truth_table_verification.PNG b/.../_static/img/examples/02_cocotb_simulation/example_truth_table_verification.PNG
diff --git a/docs/autoapi/piel/index.rst b/docs/autoapi/piel/index.rst
@@ -29,7 +29,6 @@ Submodules
 
    cli/index.rst
    config/index.rst
-   defaults/index.rst
    file_conversion/index.rst
    file_system/index.rst
    parametric/index.rst
@@ -153,8 +152,6 @@ Attributes
 .. autoapisummary::
 
    piel.piel_path_types
-   piel.test_spm_open_lane_configuration
-   piel.example_open_lane_configuration
    piel.delete_simulation_output_files
    piel.get_simulation_output_files
    piel.snet
@@ -168,14 +165,6 @@ Attributes
 
 
 
-.. py:data:: test_spm_open_lane_configuration
-
-
-
-.. py:data:: example_open_lane_configuration
-
-
-
 .. py:function:: check_path_exists(path: piel.config.piel_path_types, raise_errors: bool = False) -> bool
 
    Checks if a directory exists.
@@ -1121,7 +1110,7 @@ Attributes
    :rtype: configuration(dict)
 
 
-.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: str | pathlib.Path) -> None
+.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: piel.config.piel_path_types) -> None
 
    Writes a `config.json` onto a `design_directory`
 
@@ -1756,6 +1745,4 @@ Attributes
 
 
 .. py:data:: __version__
-   :value: '0.0.47'
-
-
+   :value: '0.0.48'
diff --git a/docs/autoapi/piel/tools/index.rst b/docs/autoapi/piel/tools/index.rst
@@ -469,7 +469,7 @@ Attributes
    :rtype: configuration(dict)
 
 
-.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: str | pathlib.Path) -> None
+.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: piel.config.piel_path_types) -> None
 
    Writes a `config.json` onto a `design_directory`
 

diff --git a/docs/autoapi/piel/tools/openlane/defaults/index.rst b/docs/autoapi/piel/tools/openlane/defaults/index.rst
@@ -0,0 +1,18 @@
+:py:mod:`piel.tools.openlane.defaults`
+======================================
+
+.. py:module:: piel.tools.openlane.defaults
+
+
+Module Contents
+---------------
+
+.. py:data:: test_spm_open_lane_configuration
+
+
+
+.. py:data:: test_basic_open_lane_configuration
+
+
+
+.. py:data:: example_open_lane_configuration
diff --git a/docs/autoapi/piel/tools/openlane/index.rst b/docs/autoapi/piel/tools/openlane/index.rst
@@ -19,6 +19,7 @@ Submodules
    :titlesonly:
    :maxdepth: 1
 
+   defaults/index.rst
    migrate/index.rst
    utils/index.rst
    v1/index.rst
@@ -210,7 +211,7 @@ Functions
    :rtype: configuration(dict)
 
 
-.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: str | pathlib.Path) -> None
+.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: piel.config.piel_path_types) -> None
 
    Writes a `config.json` onto a `design_directory`
 

diff --git a/docs/autoapi/piel/tools/openlane/v1/index.rst b/docs/autoapi/piel/tools/openlane/v1/index.rst
@@ -145,7 +145,7 @@ Functions
    :rtype: configuration(dict)
 
 
-.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: str | pathlib.Path) -> None
+.. py:function:: write_configuration_openlane_v1(configuration: dict, design_directory: piel.config.piel_path_types) -> None
 
    Writes a `config.json` onto a `design_directory`
 

diff --git a/piel/tools/openlane/defaults.py b/piel/tools/openlane/defaults.py
@@ -27,6 +27,7 @@
     "FP_PDN_VOFFSET": 5,
     "FP_PDN_HOFFSET": 5,
     "DIODE_INSERTION_STRATEGY": 3,
+    "RUN_LINTER": False,
 }
 
 example_open_lane_configuration = {