From bfbcaedd6c16032c81497e21bab666d5ac66c369 Mon Sep 17 00:00:00 2001
From: Matt Venn <matt@mattvenn.net>
Date: Tue, 4 Apr 2023 19:14:37 +0200
Subject: [PATCH] update datasheet to include STA

---
 caravel.py            |  3 +--
 docs/STA.md           | 10 ++++++----
 docs/hugo_template.md |  1 +
 documentation.py      |  8 ++++----
 4 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/caravel.py b/caravel.py
index 3581584..375c070 100644
--- a/caravel.py
+++ b/caravel.py
@@ -41,7 +41,6 @@ class CaravelConfig():
                     if row == 0 and col <= 1:
                         continue
 
-                    logging.debug(self.num_projects)
                     if num_macros_placed < self.num_projects:
                         if orientation == 'N':
                             # scanchain first
@@ -71,7 +70,7 @@ class CaravelConfig():
                             )
                             fh.write(instance)
 
-                    num_macros_placed += 1
+                        num_macros_placed += 1
 
         logging.info(f"total user macros placed: {num_macros_placed}")
 
diff --git a/docs/STA.md b/docs/STA.md
index 0edb00a..6d3a684 100644
--- a/docs/STA.md
+++ b/docs/STA.md
@@ -55,11 +55,13 @@ substitute the [nnn] with _nnn_ in the names
 
 eg:
 
-    sta_top/toplevel_sta.py ./verilog/gl/user_project_wrapper.v ./spef/user_project_wrapper.spef ./sta_top/top.sdc > sta.log
+    sta_top/toplevel_sta.py ./verilog/gl/user_project_wrapper.v 
+    ./spef/user_project_wrapper.spef ./sta_top/top.sdc > sta.log
 
-Alternately you can enter interactive mode after analysis:
+Alternatively you can enter interactive mode after analysis:
 
-    sta_top/toplevel_sta.py ./verilog/gl/user_project_wrapper.v ./spef/user_project_wrapper.spef ./sta_top/top.sdc -i
+    sta_top/toplevel_sta.py ./verilog/gl/user_project_wrapper.v 
+    ./spef/user_project_wrapper.spef ./sta_top/top.sdc -i
 
 ## How it works
 
@@ -109,5 +111,5 @@ needs to be set in ~/spice.rc and/or ~/.spiceinit:
 
 This chart shows the input clock and how it changes after 250 blocks. It was simulated for 200n to capture a clean pair of clock pulses.
 
-[clock_spice.png](pics/clock_spice.png)
+![clock_spice.png](pics/clock_spice.png)
 
diff --git a/docs/hugo_template.md b/docs/hugo_template.md
index 6746583..96ab27a 100644
--- a/docs/hugo_template.md
+++ b/docs/hugo_template.md
@@ -1,4 +1,5 @@
 ---
+hidden: true
 title: "{index} {title}"
 weight: {weight}
 ---
diff --git a/documentation.py b/documentation.py
index 800ca6f..1c8dc69 100644
--- a/documentation.py
+++ b/documentation.py
@@ -83,17 +83,17 @@ class Docs():
                 try:
                     doc = doc_template.format(**yaml_data)
                     fh.write(doc)
-                    fh.write("\n\pagebreak\n")
+                    fh.write("\n\clearpage\n")
                 except IndexError:
                     logging.warning("missing pins in info.yaml, skipping")
 
             # ending
             fh.write(doc_info)
-            fh.write("\n\pagebreak\n")
+            fh.write("\n\clearpage\n")
             fh.write(doc_verification)
-            fh.write("\n\pagebreak\n")
+            fh.write("\n\clearpage\n")
             fh.write(doc_sta)
-            fh.write("\n\pagebreak\n")
+            fh.write("\n\clearpage\n")
             fh.write(doc_credits)
 
         logging.info(f'wrote markdown to {self.args.dump_markdown}')