Start adding some documentation for steps. Don't expose for now as interfaces need fixing for boards, sim etc

Author: robtaylor

chipflow_lib/steps/__init__.py

@@ -0,0 +1,17 @@
+"""
+Steps provide an extensible way to modify the `chipflow` command behavior for a given design
+"""
+
+from abc import ABC
+
+class StepBase(ABC):
+    def __init__(self, config):
+        self.platform = platform
+
+    def build_cli_parser(self, parser):
+        "Build the cli parser for this step"
+        ...
+
+    def run_cli(self, args):
+        "Called when this step's is used from `chipflow` command"
+        self.build()

chipflow_lib/steps/board.py

@@ -13,4 +13,5 @@ def run_cli(self, args):
         self.build()
 
     def build(self):
+        "Build for the given platform"
         self.platform.build()

chipflow_lib/steps/silicon.py

@@ -53,7 +53,7 @@ def elaborate(self, platform: SiliconPlatform):
 
 
 class SiliconStep:
-    """Prepare and submit the design for an ASIC."""
+    """Step to Prepare and submit the design for an ASIC."""
     def __init__(self, config):
         self.config = config
 

chipflow_lib/steps/software.py

@@ -4,8 +4,8 @@
 from doit.doit_cmd import DoitMain
 
 
-class SoftwareStep:
-    """Build the software."""
+class SoftwareStep(StepBase):
+    """Base step to build the software."""
 
     doit_build_module = None
 
@@ -19,7 +19,9 @@ def run_cli(self, args):
         self.build()
 
     def doit_build(self):
+        "Run the overridden doit_build_module"
         DoitMain(ModuleTaskLoader(self.doit_build_module)).run(["build_software"])
 
     def build(self):
+        "Build the software for your design"
         self.doit_build()