scripts to fix codox generation

Generating_Documentation.md

@@ -0,0 +1,4 @@
+To generate documentation with codox, run "lein codox" on command line to generate first batch of HTMl files.
+Then, run FunctionsToMD to take Push instructions generated by `def-instruction` and spit it out to a Markdown file.
+Then, run HTMLFix to fix the ordered lists in `Adding_Genetic_Operators.md`, `Adding_Problem.md`, and 
+`Adding_Selection_Method.md`. 

scripts/FunctionsToMD.py

@@ -4,11 +4,13 @@
 
 import os
 from mdutils.mdutils import MdUtils
-mdFile = MdUtils(file_name='src/docs_src/Additional_Instructions', title='Bool, Char, Code, Input-Output, Numeric, and String Instructions')
-
+mdFile = MdUtils(file_name='src/docs_src/Additional_Instructions')
+mdFile.new_header(level=1, title='Additional Instructions')
 os.chdir('..')
 
 instructionFiles = os.listdir('src/propeller/push/instructions')
+instructionFiles.remove('vector.cljc')
+instructionFiles.remove('polymorphic.cljc')
 print(instructionFiles)
 
 hasDefInstruction = False
@@ -59,6 +61,7 @@ for file in instructionFiles:
         # found in the text file
         if not hasDefInstruction:
             print("\n\"" + text + "\" is not found in \"" + file + "\"!")
+            mdFile.new_paragraph('')
         else:
             print("There is"+text)
 
@@ -66,5 +69,5 @@ for file in instructionFiles:
     # if input file doesn't exist
     except:
         print("\nThe file doesn't exist!")
-
+mdFile.new_table_of_contents()
 mdFile.create_md_file()

scripts/HTMLFix.py

@@ -0,0 +1,27 @@
+
+# fixes ordered lists in codox-generated HTML for specific files
+
+import os
+
+os.chdir('..')
+htmlFiles = ['Adding_Genetic_Operators.html', 'Adding_Problem.html', 'Adding_Selection_Method.html']
+
+
+for file in htmlFiles:
+
+    with open('docs/'+file, 'r') as f:
+        OL = "ol>"
+        countOL = 0
+        newline = []
+        for line in f.readlines():
+            if OL in line:
+                countOL = countOL + 1
+                if countOL != 2 and countOL != 3 and countOL != 6 and countOL != 7:
+                    newline.append(line)
+            else:
+                newline.append(line)
+
+    with open('docs/'+file, 'w') as f:
+        for line in newline:
+            f.writelines(line)
+

src/docs_src/Additional_Instructions.md

@@ -1,12 +1,24 @@
 
-Bool, Char, Code, Input-Output, Numeric, and String Instructions
-================================================================
+
+
+
+Table of contents
+=================
+
+* [Additional Instructions](#additional-instructions)
+* [input_output.cljc](#input_outputcljc)
+* [numeric.cljc](#numericcljc)
+* [string.cljc](#stringcljc)
+* [character.cljc](#charactercljc)
+* [bool.cljc](#boolcljc)
+* [code.cljc](#codecljc)
+
+# Additional Instructions
 
 # input_output.cljc
 
 ## :print_newline
-Prints new line
-
+Prints new line 
 # numeric.cljc
 
 ## :float_cos
@@ -80,8 +92,7 @@ Splits the top STRING on whitespace, and pushes back the resulting components in
 ## :string_substr
 Pushes the substring of the top STRING, with beginning and end indices determined by the second topmost and topmost INTEGERs respectively. If an index is out of bounds, the beginning/end of the string is used instead 
 ## :string_take
-Pushes the substring of the top STRING consisting of its first n letters, where n is determined by the top INTEGER
-
+Pushes the substring of the top STRING consisting of its first n letters, where n is determined by the top INTEGER 
 # character.cljc
 
 ## :char_is_letter