Changeset c26897a in sasmodels for doc/gentoc.py

Timestamp:

Jun 26, 2017 8:13:26 AM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

870a2f4

Parents:

b52e00f (diff), c935936 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' into doc_update

File:

• doc/gentoc.py (modified) (6 diffs)

doc/gentoc.py

@@ -16 +16 @@
     from sasmodels.modelinfo import ModelInfo
 
-TEMPLATE="""\
+TEMPLATE = """\
 ..
     Generated from doc/gentoc.py -- DO NOT EDIT --
@@ -30 +30 @@
 """
 
-MODEL_TOC_PATH = "ref/models"
+MODEL_TOC_PATH = "guide/models"
 
 def _make_category(category_name, label, title, parent=None):
@@ -65 +65 @@
         # assume model is in sasmodels/models/name.py, and ignore the full path
         model_name = basename(item)[:-3]
-        if model_name.startswith('_'): continue
+        if model_name.startswith('_'):
+            continue
         model_info = load_model_info(model_name)
         if model_info.category is None:
             print("Missing category for", item, file=sys.stderr)
         else:
-            category.setdefault(model_info.category,[]).append(model_name)
+            category.setdefault(model_info.category, []).append(model_name)
 
     # Check category names
-    for k,v in category.items():
+    for k, v in category.items():
         if len(v) == 1:
-            print("Category %s contains only %s"%(k,v[0]), file=sys.stderr)
+            print("Category %s contains only %s"%(k, v[0]), file=sys.stderr)
 
     # Generate category files for the table of contents.
@@ -86 +87 @@
     # alphabetical order before them.
 
-    if not exists(MODEL_TOC_PATH): mkdir(MODEL_TOC_PATH)
+    if not exists(MODEL_TOC_PATH):
+        mkdir(MODEL_TOC_PATH)
     model_toc = _make_category(
-        'index',  'Models', 'Model Functions')
+        'index', 'Models', 'Model Functions')
     #shape_toc = _make_category(
     #    'shape',  'Shapes', 'Shape Functions', model_toc)
     free_toc = _make_category(
-        'shape-independent',  'Shape-independent',
+        'shape-independent', 'Shape-independent',
         'Shape-Independent Functions')
     struct_toc = _make_category(
-        'structure-factor',  'Structure-factor', 'Structure Factors')
-    custom_toc = _make_category(
-        'custom-models',  'Custom-models', 'Custom Models')
+        'structure-factor', 'Structure-factor', 'Structure Factors')
+    #custom_toc = _make_category(
+    #    'custom-models', 'Custom-models', 'Custom Models')
 
     # remember to top level categories
@@ -105 +107 @@
         'shape-independent':free_toc,
         'structure-factor': struct_toc,
-        'custom': custom_toc,
+        #'custom': custom_toc,
         }
 
     # Process the model lists
-    for k,v in sorted(category.items()):
+    for k, v in sorted(category.items()):
         if ':' in k:
-            cat,subcat = k.split(':')
+            cat, subcat = k.split(':')
             _maybe_make_category(cat, v, cat_files, model_toc)
             cat_file = cat_files[cat]
-            label = "-".join((cat,subcat))
+            label = "-".join((cat, subcat))
             filename = label
-            title = subcat.capitalize()+" Functions"
+            title = subcat.capitalize() + " Functions"
             sub_toc = _make_category(filename, label, title, cat_file)
             for model in sorted(v):
@@ -130 +132 @@
     _add_subcategory('shape-independent', model_toc)
     _add_subcategory('structure-factor', model_toc)
-    _add_subcategory('custom-models', model_toc)
+    #_add_subcategory('custom-models', model_toc)
 
     # Close the top-level category files
     #model_toc.close()
-    for f in cat_files.values(): f.close()
+    for f in cat_files.values():
+        f.close()