propeller/Generating_Documentation.md
2023-01-25 14:26:53 -05:00

9 lines
510 B
Markdown

# Generating Documentation for Propeller
To generate documentation with [codox](https://github.com/weavejester/codox), run `GenerateDocs.sh` in the command line.
This will run "lein codox" on the command line to generate first batch of HTMl files.
Then, it runs FunctionsToMD to take Push instructions generated by `def-instruction` and spit it out to a Markdown file.
Then, it runs HTMLFix to fix the ordered lists in `Adding_Genetic_Operators.md`, `Adding_Problem.md`, and
`Adding_Selection_Method.md`.