Use tabulate

Author: pgleeson

examples/document.rst

@@ -6,19 +6,14 @@ A model for documents
 Allowed parameters
 ==================
 
-============ === =====================
-<b>title</b> str <i>Document title</i>
-============ === =====================
-=========== === =========================================
-<b>ISBN</b> int <i>International Standard Book Number</i>
-=========== === =========================================
-========= === ===========================
-<b>id</b> str <i>Unique ID of element</i>
-========= === ===========================
-============ === ===========================
-<b>notes</b> str <i>Human readable notes</i>
-============ === ===========================
-</table>
+===============  ===========  ====================================
+Allowed field    Data Type    Description
+===============  ===========  ====================================
+**title**        str          *Document title*
+**ISBN**         int          *International Standard Book Number*
+**id**           str          *Unique ID of element*
+**notes**        str          *Human readable notes*
+===============  ===========  ====================================
 
 Allowed children
 ================

modelspec/BaseTypes.py

@@ -2,6 +2,7 @@
 import json
 import sys
 from collections import OrderedDict
+from tabulate import tabulate
 
 verbose = False
 
@@ -415,6 +416,7 @@ def insert_links(text):
             if format == RST_FORMAT:
                 ap = "Allowed parameters"
                 doc_string += "%s\n%s\n\n" % (ap,"="*len(ap))
+                table_info = []
         if format == DICT_FORMAT:
             doc_dict[name]["allowed_parameters"] = {}
 
@@ -445,19 +447,16 @@ def insert_links(text):
                     insert_links(self.allowed_fields[f][0])
                 )
             if format == RST_FORMAT:
-                n = "<b>%s</b>" % f
+                n = "**%s**" % f
                 t = "%s" % (
                     '<a href="#%s">%s</a>' % (type_.lower(), type_)
                     if referencable
                     else type_,
                 )
-                d = "<i>%s</i>" % (
+                d = "*%s*" % (
                     insert_links(self.allowed_fields[f][0])
                 )
-
-                doc_string += "%s %s %s\n"%("="*len(n),"="*len(t),"="*len(d))
-                doc_string += "%s %s %s\n"%(n,t,d)
-                doc_string += "%s %s %s\n"%("="*len(n),"="*len(t),"="*len(d))
+                table_info.append([n,t,d])
 
             if referencable:
                 inst = self.allowed_fields[f][1]()
@@ -468,7 +467,7 @@ def insert_links(text):
             if format == MARKDOWN_FORMAT:
                 doc_string += "</table>\n\n"
             if format == RST_FORMAT:
-                doc_string += "</table>\n\n"
+                doc_string += "%s\n\n"%(tabulate(table_info, ['Allowed field','Data Type','Description'], tablefmt="rst"))
 
         if len(self.allowed_children) > 0:
             if format == MARKDOWN_FORMAT:

setup.py

@@ -15,7 +15,7 @@
     description="A common JSON/YAML based format for compact model specification",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
-    install_requires=["pyyaml", "numpy"],
+    install_requires=["pyyaml", "numpy", "tabulate"],
     classifiers=[
         "Intended Audience :: Science/Research",
         "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",