From 860447e61839322bef4ee86724e8dbf44d89f57f Mon Sep 17 00:00:00 2001
From: Pat Deegan <pat.devel@psychogenic.com>
Date: Thu, 1 Jun 2023 01:47:30 -0400
Subject: [PATCH] bidirectional pin support in gen'ed docs (#15)

* Doc support for bidirectional pins
---
 docs/project_preview.md | 20 ++++++++++----------
 project.py              |  3 ++-
 2 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/docs/project_preview.md b/docs/project_preview.md
index 5981c26..7b335f4 100644
--- a/docs/project_preview.md
+++ b/docs/project_preview.md
@@ -16,13 +16,13 @@
 
 ### IO
 
-| # | Input        | Output       |
-|---|--------------|--------------|
-| 0 | {inputs[0]}  | {outputs[0]} |
-| 1 | {inputs[1]}  | {outputs[1]} |
-| 2 | {inputs[2]}  | {outputs[2]} |
-| 3 | {inputs[3]}  | {outputs[3]} |
-| 4 | {inputs[4]}  | {outputs[4]} |
-| 5 | {inputs[5]}  | {outputs[5]} |
-| 6 | {inputs[6]}  | {outputs[6]} |
-| 7 | {inputs[7]}  | {outputs[7]} |
+| # | Input        | Output       | Bidirectional      |
+|---|--------------|--------------|--------------------|
+| 0 | {inputs[0]}  | {outputs[0]} | {bidirectional[0]} |
+| 1 | {inputs[1]}  | {outputs[1]} | {bidirectional[1]} |
+| 2 | {inputs[2]}  | {outputs[2]} | {bidirectional[2]} |
+| 3 | {inputs[3]}  | {outputs[3]} | {bidirectional[3]} |
+| 4 | {inputs[4]}  | {outputs[4]} | {bidirectional[4]} |
+| 5 | {inputs[5]}  | {outputs[5]} | {bidirectional[5]} |
+| 6 | {inputs[6]}  | {outputs[6]} | {bidirectional[6]} |
+| 7 | {inputs[7]}  | {outputs[7]} | {bidirectional[7]} |
diff --git a/project.py b/project.py
index bddb5b3..79c1dba 100644
--- a/project.py
+++ b/project.py
@@ -197,6 +197,7 @@ class Project():
         rgx_mod  = re.compile(r"(?:^|[\s])module[\s]{1,}([\w]+)")
         top_verilog = []
         for src in self.src_files:
+            print(f'SRC {src}')
             with open(os.path.join(self.local_dir, 'src', src)) as fh:
                 for line in fh.readlines():
                     for match in rgx_mod.finditer(line):
@@ -398,7 +399,7 @@ class Project():
     def check_yaml_docs(self):
         yaml = self.yaml
         logging.info("checking docs")
-        for key in ['author', 'title', 'description', 'how_it_works', 'how_to_test', 'language', 'inputs', 'outputs']:
+        for key in ['author', 'title', 'description', 'how_it_works', 'how_to_test', 'language', 'inputs', 'outputs', 'bidirectional']:
             if key not in yaml['documentation']:
                 logging.error("missing key {} in documentation".format(key))
                 exit(1)