#57 add revision to tutorial markdown generator

Author: kwabenantim

infra/CreateMarkdownTutorial.py

@@ -192,7 +192,7 @@ def CodeBlockOpener(file_name):
     return '```' + highlight_code
 
 def AddCodeOutput(file_name, code, output):
-    output.append('\n\n## File name `%s` \n\n' % file_name)
+    output.append('\n\n### File name %s \n\n' % file_name)
     output.append(CodeBlockOpener(file_name))
     output.append('\n'.join(code))
     output.append('\n```\n\n')
@@ -207,13 +207,17 @@ def ConvertTutorialToMarkdownText(test_file_path, test_file, other_files, revisi
     the contents as for test_file.
     """
     if revision:
-        revision = ' at revision r' + str(revision)
+        revision_text = f' at revision [{revision[:8]}](https://github.com/Chaste/PyChaste/commit/{revision})'
+    else:
+        revision_text = ''
+
     output = []
     # Header
     regex = re.compile(r'(?!^)(?=[A-Z])', re.MULTILINE)
     ugly_file_name = os.path.splitext(os.path.basename(test_file_path))[0] 
     nice_file_name = re.sub(regex, " ", ugly_file_name)
 
+    link_path = f"https://github.com/Chaste/PyChaste/blob/develop/test/tutorials/{ugly_file_name}.py"
     page_header = f"""
 ---
 title : "{nice_file_name}"
@@ -224,10 +228,9 @@ def ConvertTutorialToMarkdownText(test_file_path, test_file, other_files, revisi
 layout: "single"
 ---
 
-This tutorial is automatically generated from the file {test_file_path} {revision}.
+This tutorial is automatically generated from [{ugly_file_name}]({link_path}){revision_text}.
 Note that the code is given in full at the bottom of the page.
 
-
 """
 
     output.append(page_header)
@@ -244,7 +247,7 @@ def ConvertTutorialToMarkdownText(test_file_path, test_file, other_files, revisi
         if file_code:
             other_code[other_file[0]] = file_code
     # Now output the C++ code for all files
-    output.append('\n\n# Code \nThe full code is given below\n')
+    output.append('\n\n## Code \nThe full code is given below\n')
     AddCodeOutput(os.path.basename(test_file_path), test_code, output)
     for filename, code in other_code.items():
         AddCodeOutput(filename, code, output)

infra/GenerateWikiPages.py

@@ -66,6 +66,9 @@
                 if not fnmatch.fnmatch(file, "*.pyc"):
                     tutorial_files.append([root, file])
 
+    # Get git revision
+    revision = subprocess.check_output(['git', 'rev-parse', 'HEAD']).decode('ascii').strip()
+
     if args.format == "markdown":
         # Generate the markdown for each
         for eachFile in tutorial_files:
@@ -75,7 +78,7 @@
                 + ".md"
             )
             inputfile = eachFile[0] + "/" + eachFile[1]
-            launch_string = f"../infra/CreateMarkdownTutorial.py {inputfile} {outfile}"
+            launch_string = f"../infra/CreateMarkdownTutorial.py {inputfile} {outfile} --revision {revision}"
             os.system(launch_string)
 
     elif args.format == "jupyter":