Make generation comment a HTML comment

bakerkj · Dec 12, 2015 · 84f3b72 · 84f3b72
1 parent 4b87b1f
commit 84f3b72
Showing 1 changed file with 10 additions and 8 deletions.
diff --git a/build_doc.py b/build_doc.py
@@ -172,6 +172,11 @@ def getHandlers(path):
 
         enabled = ''
 
+        docFile.write("<!--")
+        docFile.write("This file was generated from the python source\n")
+        docFile.write("Please edit the source to make changes\n")
+        docFile.write("-->\n")
+
         docFile.write("%s\n" % (collector))
         docFile.write("=====\n")
         if collectors[collector].__doc__ is None:
@@ -217,9 +222,6 @@ def getHandlers(path):
         docFile.write("__EXAMPLESHERE__\n")
         docFile.write("```\n")
         docFile.write("\n")
-        docFile.write("### This file was generated from the python source\n")
-        docFile.write("### Please edit the source to make changes\n")
-        docFile.write("\n")
 
         docFile.close()
 
@@ -266,6 +268,11 @@ def getHandlers(path):
         docFile = open(os.path.join(handlers_doc_path,
                                     handler + ".md"), 'w')
 
+        docFile.write("<!--")
+        docFile.write("This file was generated from the python source\n")
+        docFile.write("Please edit the source to make changes\n")
+        docFile.write("-->\n")
+
         docFile.write("%s\n" % (handler))
         docFile.write("====\n")
         docFile.write("%s" % (handlers[handler].__doc__))
@@ -306,9 +313,4 @@ def getHandlers(path):
 
         docFile.write("</table>\n")
 
-        docFile.write("\n")
-        docFile.write("### This file was generated from the python source\n")
-        docFile.write("### Please edit the source to make changes\n")
-        docFile.write("\n")
-
         docFile.close()