Changeset 19dcb933 in sasmodels for sasmodels/gen.py

Timestamp:

Sep 3, 2014 1:16:10 AM (10 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

1c7ffdc

Parents:

87985ca

Message:

build docs for models

File:

• sasmodels/gen.py (modified) (5 diffs)

sasmodels/gen.py

@@ -203 +203 @@
 # Headers for the parameters tables in th sphinx documentation
 PARTABLE_HEADERS = [
-    "Parameter name",
+    "Parameter",
+    "Description",
     "Units",
     "Default value",
@@ -395 +396 @@
 DOC_HEADER=""".. _%(name)s:
 
-%(name)s
+%(label)s
 =======================================================
 
@@ -542 +543 @@
     return kernel
 
-def make_partable(info):
+def make_partable(pars):
     """
     Generate the parameter table to include in the sphinx documentation.
     """
-    pars = info['parameters']
+    pars = COMMON_PARAMETERS + pars
     column_widths = [
         max(len(p[0]) for p in pars),
+        max(len(p[-1]) for p in pars),
         max(len(RST_UNITS[p[1]]) for p in pars),
         PARTABLE_VALUE_WIDTH,
@@ -564 +566 @@
         lines.append(" ".join([
             "%-*s"%(column_widths[0],p[0]),
-            "%-*s"%(column_widths[1],RST_UNITS[p[1]]),
-            "%*g"%(column_widths[2],p[2]),
+            "%-*s"%(column_widths[1],p[-1]),
+            "%-*s"%(column_widths[2],RST_UNITS[p[1]]),
+            "%*g"%(column_widths[3],p[2]),
             ]))
     lines.append(sep)
@@ -678 +681 @@
     Return the documentation for the model.
     """
-    subst = dict(name=kernel_module.name,
+    subst = dict(name=kernel_module.name.replace('_','-'),
+                 label=" ".join(kernel_module.name.split('_')).capitalize(),
                  title=kernel_module.title,
                  parameters=make_partable(kernel_module.parameters),
-                 doc=kernel_module.__doc__)
+                 docs=kernel_module.__doc__)
     return DOC_HEADER%subst