Merge pull request #424 from arturum1/main

Fix documentation tables

Author: jjts

py2hwsw/document/tsrc/ug.cls

@@ -95,3 +95,11 @@
 
 \graphicspath{ {./figures/} }
 
+% Custom alternative to \hline that prevents latex from breaking table rows into new pages
+\makeatletter
+\def\nobreakhline{%
+  \multispan\LT@cols
+  \unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
+  \noalign{\penalty10000}%
+}
+\makeatother

py2hwsw/lib/hardware/iob_csrs/scripts/csr_gen.py

@@ -1505,15 +1505,18 @@ def generate_csrs_tex(doc_tables, out_dir):
   \\customcsrshhline
   \\rowcolor{iob-green}
               &            &             & {\\bf Hw}       & {\\bf Sw}     &                &                    \\\\ \\hline \\hline
+  \\endfirsthead
+  \\hline
+  \\caption{"""
+                    + csr_group.descr.replace("_", "\\_")
+                    + """}
+  \\endlastfoot
 
   \\input """
                     + doc_conf
                     + f"_{csr_group.name}"
                     + """_csrs_tab
 
-  \\caption{"""
-                    + csr_group.descr.replace("_", "\\_")
-                    + """}
 \\end{xltabular}
 \\label{"""
                     + doc_conf

py2hwsw/lib/hardware/memories/iob_memwrapper/iob_memwrapper.py

@@ -208,8 +208,11 @@ def generate_mems_tex(mems, out_dir):
       \\hline
       \\rowcolor{iob-green}
       {\\bf Name} & {\\bf Type} & {\\bf (Word-)Addr Width} & {\\bf Data Width} & {\\bf Init file} \\\\ \\hline
-      \\input mems_tab
+      \\endfirsthead
+      \\hline
       \\caption{Core memories.}
+      \\endlastfoot
+      \\input mems_tab
     \\end{xltabular}
     \\label{mems_tab:is}
 }

py2hwsw/lib/iob_system/iob_system_linux/submodules/iob_uart16550

@@ -10,10 +10,13 @@
   \hline
   \rowcolor{iob-green}
   {\bf Name} & {\bf Directory}  \\ \hline \hline
+  \endfirsthead
+  \hline
+  \caption{Cores available in the library of the Py2HWSW framework. The \textit{Directory} column is the path to the core's setup directory, relative to the Py2HWSW lib directory \texttt{py2hwsw/lib/}.}
+  \endlastfoot
 
   \input py2hwsw_core_lib_tab
 
-  \caption{Cores available in the library of the Py2HWSW framework. The \textit{Directory} column is the path to the core's setup directory, relative to the Py2HWSW lib directory \texttt{py2hwsw/lib/}.}
   \label{py2hwsw_core_lib_tab}
 \end{xltabular}
 }

py2hwsw/lib/iob_system/submodules/iob_cache

@@ -29,10 +29,13 @@
   \hline
   \rowcolor{iob-green}
   {\bf Name} & {\bf Data Type} & {\bf Description}  \\ \hline \hline
+  \endfirsthead
+  \hline
+  \caption{Standard \textit{Python Parameters} passed by Py2HWSW to every core's "setup" function.}
+  \endlastfoot
 
   \input py2hwsw_py_params_tab
 
-  \caption{Standard \textit{Python Parameters} passed by Py2HWSW to every core's "setup" function.}
 \end{xltabular}
 \label{py2hwsw_py_params_tab}
 }
@@ -54,10 +57,13 @@
   \rowcolor{iob-green}
   % TODO: The "Data Type" column should specify what the user should input, instead of the internal object used by py2hwsw.
   {\bf Name} & {\bf Data Type} & {\bf Description}  \\ \hline \hline
+  \endfirsthead
+  \hline
+  \caption{Supported Py2HWSW attributes in the \textbf{Core Dictionary}. The \textit{Data Type} column specifies the type of internal object that the Py2HWSW will convert the attribute's value to (usually the user inputs a string, list, or dictionary value and then py2 converts it to an internal object).}
+  \endlastfoot
 
   \input py2hwsw_attributes_tab
 
-  \caption{Supported Py2HWSW attributes in the \textbf{Core Dictionary}. The \textit{Data Type} column specifies the type of internal object that the Py2HWSW will convert the attribute's value to (usually the user inputs a string, list, or dictionary value and then py2 converts it to an internal object).}
   \label{py2hwsw_attributes_tab}
 \end{xltabular}
 }

py2hwsw/lib/iob_system/submodules/iob_eth

@@ -32,10 +32,13 @@ def generate_subblocks_table_tex(subblocks, out_dir):
   \\hline
   \\rowcolor{iob-green}
   {\\bf Name} & {\\bf Description}  \\\\ \\hline \\hline
+  \\endfirsthead
+  \\hline
+  \\caption{Core subblocks.}
+  \\endlastfoot
 
   \\input subblocks_tab
 
-  \\caption{Core subblocks.}
 \\end{xltabular}
 \\label{subblocks_tab:is}
 }

py2hwsw/py2hwsw_document/document/tsrc/core_lib.tex

@@ -183,14 +183,17 @@ def generate_config_tex(confs, out_dir):
   \\hline
   \\rowcolor{iob-green}
   {\\bf Configuration} & {\\bf Type} & {\\bf Min} & {\\bf Typical} & {\\bf Max} & {\\bf Description} \\\\ \\hline \\hline
+  \\endfirsthead
+  \\hline
+  \\caption{"""
+                + group.descr.replace("_", "\\_")
+                + """}
+  \\endlastfoot
 
   \\input """
                 + group.name
                 + """_confs_tab
 
-  \\caption{"""
-                + group.descr.replace("_", "\\_")
-                + """}
 \\end{xltabular}
 \\label{"""
                 + group.name