[release] Regular merge of develop

.ci/generateIndex.py

@@ -42,6 +42,35 @@ def build_section_start(title, shortcut):
 def build_section_end():
     return "\t\t</ul>\n\t</div>"
 
+def save_order(localroot, root, filename):
+    order = ""
+    os.chdir(root)
+
+    with open(filename, 'r') as f:
+        for line in f:
+            # check for the start of the section
+            if line[0:6] == "order:":
+                order = line[7:]
+                break
+
+    # change back to the local root
+    os.chdir(localroot)
+
+    return order.rstrip()
+
+def get_ignore():
+    return ["404.html",
+            "Gemfile",
+            "Gemfile.lock",
+            "README.md",
+            "_config.yml",
+            "_site",
+            "assets",
+            "help.md",
+            "index.md",
+            "pagination.md"
+            ]
+
 def save_legacy_from(localroot, root, filename):
     legacy_from = []
     os.chdir(root)
@@ -56,12 +85,13 @@ def save_legacy_from(localroot, root, filename):
                 legacy_from_flag = True
 
             # append lines from the legacy section
-            if legacy_from_flag and line[0:12]:
+            if legacy_from_flag:
                 legacy_from.append(line)
 
             # check for the end of the header
             if legacy_from_flag and line[0:3] == "---":
                legacy_from_flag = False
+               break
 
     # change back to the local root
     os.chdir(localroot)
@@ -75,6 +105,7 @@ def remove_header(localroot, root, filename):
 
     # count the number of lines
     count = 0
+    n = 0
     headerCheck = False
     with open(filename, 'r') as f:
         for line in f:
@@ -105,6 +136,8 @@ def remove_header(localroot, root, filename):
 # loop through the entire internal tree
 localroot = os.getcwd()
 
+# retrieve ignore list
+ignore = get_ignore()
 
 # generate the index properly speaking
 cardDirs = ["internal", "external", "policies"]
@@ -117,7 +150,7 @@ for direct in cardDirs:
         dirs = natsorted(dirs)
 
         for d in dirs:
-            if d[0] != ".":
+            if d[0] != "." and d not in ignore:
                 sections.append(d)
 
 sections = list(set(sections))
@@ -128,24 +161,27 @@ index = ''
 index += '\n<div class="index-box-container">\n'
 whiteList = ''
 
-localIndexArr = [[]] * len(sections)
+localIndexArr = {k: [] for k in range(len(sections))}
+orderArr = {k: [] for k in range(len(sections))}
+
 for folder in cardDirs:
+    # FolderFlag gets set to true at the first iteration
+    folderFlag = True
 
     # check if folder exists
-    if path.isdir(folder):
+    if path.isdir(folder) and folder not in ignore:
         dirs = os.listdir(folder)
         dirs = natsorted(dirs)
 
         for d in dirs:
-            if d[0] != ".":
+            if d[0] != "." and d not in ignore:
                 # set the header of the section
                 #index += "\n### " + d.replace("-", " ").capitalize() + "\n"
 
-
                 # get the index of the section
                 indexS = sections.index(d)
+                maxOrder = 0
 
-                #print(indexS)
                 if len(localIndexArr[indexS]) == 0:
                     localIndexArr[indexS] = ["\n"]
 
@@ -159,7 +195,8 @@ for folder in cardDirs:
                             if file[0] != "_":
                                 print(" > Generating header for: " + fileName)
 
-                                # save legacy section
+                                # save order and legacy section
+                                order = save_order(localroot, root, file)
                                 legacy_from = save_legacy_from(localroot, root, file)
 
                                 # remove the previous header
@@ -179,6 +216,26 @@ for folder in cardDirs:
 
                                 # define the header for each card
                                 header = "---\n"
+
+                                if len(order) > 0:
+                                    header += "order: " + str(order) + "\n"
+                                    # append the order of the card
+                                    # find the maximum of existing orders
+
+                                    if folderFlag:
+                                        if len(orderArr[indexS]) > 0:
+                                            maxOrder = max(orderArr[indexS])
+                                        else:
+                                            maxOrder = 0
+                                        # after determining the max order, set the folder flag to False to avoid another entry into the same block of code
+                                        folderFlag = False
+
+                                    tmp = orderArr[indexS].copy()
+                                    tmp.append(maxOrder + int(order))
+                                    orderArr[indexS] = tmp
+                                else:
+                                    orderArr[indexS] = []
+
                                 header += "layout: page\n"
                                 header += "permalink: " + permalink + "\n"
                                 header += "shortcut: " + root_handbook(shortcut) + "\n"
@@ -235,8 +292,21 @@ for folder in cardDirs:
                                 print(" + New header added.")
                                 print("-----------------------")
 
-                # join all subcategories to the index
-                localIndexArr[indexS] = natsorted(localIndexArr[indexS])
+
+# ordering of cards
+for d in sections:
+    indexS = sections.index(d)
+
+    # join all subcategories to the index
+    # if all subcategories have a predefined order
+    if len(orderArr[indexS]) == len(localIndexArr[indexS])-1 and len(orderArr[indexS]) > 0:
+        print("")
+        X = localIndexArr[indexS][1:]
+        Y = orderArr[indexS]
+        localIndexArr[indexS] = [x for _, x in sorted(zip(Y, X))]
+    # natural sorting otherwise
+    else:
+        localIndexArr[indexS] = natsorted(localIndexArr[indexS])
 
 print(localIndexArr)