Changeset e88bb78 in sasmodels

Timestamp:

Dec 1, 2015 12:40:17 PM (9 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:

7bb290c

Parents:

d18f8a8

Message:

Convert subsection headings to emphasized text in model docs

File:

• sasmodels/generate.py (modified) (4 diffs)

sasmodels/generate.py

@@ -203 +203 @@
     splitext
 import re
+import string
 
 import numpy as np
@@ -605 +606 @@
     return source, info
 
+section_marker = re.compile(r'\A(?P<first>[%s])(?P=first)*\Z'
+                            %re.escape(string.punctuation))
+def _convert_section_titles_to_boldface(lines):
+    prior = None
+    for line in lines:
+        if prior is None:
+            prior = line
+        elif section_marker.match(line):
+            if len(line) >= len(prior):
+                yield "".join( ("**",prior,"**") )
+                prior = None
+            else:
+                yield prior
+                prior = line
+        else:
+            yield prior
+            prior = line
+    if prior is not None:
+        yield prior
+
+def convert_section_titles_to_boldface(string):
+    return "\n".join(_convert_section_titles_to_boldface(string.split('\n')))
+
 def doc(kernel_module):
     """
@@ -613 +637 @@
     info = make_info(kernel_module)
     is_Sq = ("structure-factor" in info['category'])
+    #docs = kernel_module.__doc__
+    docs = convert_section_titles_to_boldface(kernel_module.__doc__)
     subst = dict(id=info['id'].replace('_', '-'),
                  name=info['name'],
@@ -618 +644 @@
                  parameters=make_partable(info['parameters']),
                  returns=Sq_units if is_Sq else Iq_units,
-                 docs=kernel_module.__doc__)
+                 docs=docs)
     return DOC_HEADER % subst