]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
doc: Print block IOs and parameters in tables
authorMichal Sojka <sojkam1@fel.cvut.cz>
Sat, 3 Oct 2015 06:41:21 +0000 (08:41 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Sun, 4 Oct 2015 07:07:15 +0000 (09:07 +0200)
rpp/blocks/scripts/doc_parse.py

index 1ccb38c57deac00181ab364d3516788aaaa257b2..d69ff907aa8cda12e16ab468483216eb2f8e3347 100755 (executable)
@@ -60,24 +60,27 @@ def print_markdown_as(format, text):
 def print_latex_desc(doc, filename):
     def iodef_str(iodef):
         if iodef is None: return "None"
-        str='%d\n\\begin{enumerate}\n' % len(iodef)
+        str ='~\n\n\\smallskip\\noindent\\begin{tabularx}{\\textwidth}{|r|l|l|X|}\n'
+        str += '\\hline\n'
+        str += '~ & \\textbf{Name} & \\textbf{Type} & \\textbf{Range or notes} \\\\ \\hline \n'
+        i = 1
         for io in iodef:
-            str += Template('\\item {\\bf $name} $type').substitute(io)
+            str += Template('%d. & $name & $type &' % i).substitute(io)
             if 'range' in io:
                 str += '  %s' % markdown_as('latex', io['range'])
             if 'note' in io:
                 str += '  %s' % markdown_as('latex', io['note'])
-            str += '\n'
-        return str +'\end{enumerate}'
+            str += '\\\\ \\hline\n'
+            i += 1
+        return str +'\\end{tabularx}'
 
     print("\\newpage\n")
     print("\\subsection{%s}" % doc['Name'])
     print("\\label{sec:block:%s}\n" % os.path.basename(filename))
-    print("\\begin{description}\n")
-    print("\\item[Inputs:]     %s\n" % iodef_str(doc['Inputs']))
-    print("\\item[Outputs:]    %s\n" % iodef_str(doc['Outputs']))
-    print("\\item[Parameters:] %s\n" % iodef_str(doc['Parameters']))
-    print("\\end{description}\n")
+    print("\\paragraph{Inputs:}     %s\n" % iodef_str(doc['Inputs']))
+    print("\\paragraph{Outputs:}    %s\n" % iodef_str(doc['Outputs']))
+    print("\\paragraph{Parameters:} %s\n" % iodef_str(doc['Parameters']))
+    print("\\paragraph{Description:}\n")
 
     print_markdown_as('latex', doc['Help'])