add note to readme in generated code

Author: almarklein

README.md

@@ -70,6 +70,8 @@ the package.
 
 ## Reference
 
+<!--- The below is autogenerated - do not edit --->
+
 ### The VolumeSlicer class
 
 **class `VolumeSlicer(app, volume, *, spacing=None, origin=None, axis=0, reverse_y=True, clim=None, scene_id=None, color=None, thumbnail=True)`**

update_docs_in_readme.py

@@ -14,6 +14,7 @@ def write_reference_docs():
     """Write the reference docs to the README."""
     # Prepare
     header = "## Reference"
+    note = "<!--- The below is autogenerated - do not edit --->"
     filename = os.path.join(HERE, "README.md")
     assert os.path.isfile(filename), "README.md not found"
     # Load first part of the readme
@@ -22,7 +23,7 @@ def write_reference_docs():
     text1, _, _ = text.partition(header)
     text1 = text1.strip()
     # Create second part of the readme
-    text2 = "\n\n\n" + header + "\n\n" + get_reference_docs()
+    text2 = "\n\n\n" + header + "\n\n" + note + "\n\n" + get_reference_docs()
     if "\r" in text1:
         text2 = text2.replace("\n", "\r\n")
     # Wite