Added timestamp generation to README.md

Author: projectkk2glider

tools/generate-api-docs.py

@@ -10,6 +10,7 @@
 import glob
 import argparse
 import urllib2
+import datetime
 
 DEBUG = False
 
@@ -19,6 +20,7 @@
 STARTMARKER = "[//]: <> (LUADOC-BEGIN:"
 ENDMARKER = "[//]: <> (LUADOC-END:"
 SUMMARYFILE = "SUMMARY.md"
+READMEFILE = "README.md"
 DOCBASE = "https://raw.githubusercontent.com/opentx/lua-reference-guide/master/"
 
 def logDebug(txt):
@@ -47,7 +49,7 @@ def parseParameters(lines):
 def extractItems(item, doc):
   # find all items
   pattern = "^@" + item + ".*?\n\s*\n"
-  items = re.findall(pattern, doc, flags = re.DOTALL | re.MULTILINE) 
+  items = re.findall(pattern, doc, flags = re.DOTALL | re.MULTILINE)
   #logDebug("Found %d %s items in %s" % (len(items), item, repr(doc)))
 
   # remove found items from the text
@@ -168,7 +170,7 @@ def addExamples(moduleName, funcName):
           # png files are linked as images
           doc += "![](%s)" % os.path.basename(fileName)
           doc += "\n\n"
-  return doc  
+  return doc
 
 def generateFunctionDoc(f):
   # f = (moduleName, funcName, funcDefinition, description, params, retvals, notices)
@@ -179,7 +181,7 @@ def generateFunctionDoc(f):
 
   # description
   doc += "%s" % f[3]
-  doc += "\n" 
+  doc += "\n"
 
   # params
   doc += "#### Parameters\n\n"
@@ -220,6 +222,13 @@ def mkdir_p(path):
 
 def insertSection(newContents, sectionName):
   logDebug("Inserting section: %s" % sectionName)
+
+  if sectionName == "timestamp":
+    newContents.append("%s%s)\n" % (STARTMARKER, sectionName))
+    newContents.append("<div class=\"footer\">last updated on %s</div>\n" % datetime.datetime.utcnow().strftime('%Y/%m/%d %H:%M:%S UTC'))
+    newContents.append("%s%s)\n" % (ENDMARKER, sectionName))
+    return
+
   newContents.append("   * [%s Functions](%s/%s_functions.md) %s%s)\n" % (sectionName.capitalize(), sectionName, sectionName, STARTMARKER, sectionName))
 
   # look for an overview for the section and insert it if found
@@ -233,16 +242,16 @@ def insertSection(newContents, sectionName):
 
   newContents[-1] = "%s %s%s)\n" % (newContents[-1].rstrip(),ENDMARKER, sectionName)
 
-def processSummary():
+def replaceSections(fileName):
   newContents = []
   ignoreLine = False
-  with open(SUMMARYFILE, "r") as summary:
-    sumContents = summary.readlines()
+  with open(fileName, "r") as data:
+    contents = data.readlines()
 
-  for line in sumContents:
-    if line.find(STARTMARKER) > 0:
+  for line in contents:
+    if line.find(STARTMARKER) >= 0:
       ignoreLine = True
-    elif line.find(ENDMARKER) > 0:
+    elif line.find(ENDMARKER) >= 0:
       # parse the section name and call insertSection
       sectionName = line.split(ENDMARKER)[1].split(")")[0]
       insertSection(newContents, sectionName)
@@ -251,10 +260,10 @@ def processSummary():
       if not ignoreLine:
         newContents.append(line)
 
-  with open(SUMMARYFILE, "w+") as out:
+  with open(fileName, "w+") as out:
     for line in newContents:
       out.write(line)
-    logInfo("generated %s" % SUMMARYFILE)
+    logInfo("generated %s" % fileName)
 
 # start of main program
 
@@ -301,4 +310,7 @@ def processSummary():
   print(summary)
 
 #now update SUMMARY.MD replacing the outdated sections
-processSummary()
+replaceSections(SUMMARYFILE)
+
+#now update the timestamp in README.md
+replaceSections(READMEFILE)