diff --git a/Generating_Documentation.md b/Generating_Documentation.md index 1109fbb..6aa6416 100644 --- a/Generating_Documentation.md +++ b/Generating_Documentation.md @@ -1,4 +1,8 @@ -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`. \ No newline at end of file +# 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`. + diff --git a/deps.edn b/deps.edn index 17c6dbb..f0bb8e3 100644 --- a/deps.edn +++ b/deps.edn @@ -7,5 +7,7 @@ :mvn/repos {} :codox {:extra-deps {codox/codox {:mvn/version "0.10.8"}} :exec-fn codox.main/generate-docs - :exec-args {:source-paths ["path/to/src"]} + :exec-args {:doc-paths ["src/docs_src"] + :output-path "docs" + :metadata {:doc "FIXME: write docs" :doc/format :markdown}} }} diff --git a/docs/Adding_Genetic_Operators.html b/docs/Adding_Genetic_Operators.html index 2839530..76c2356 100644 --- a/docs/Adding_Genetic_Operators.html +++ b/docs/Adding_Genetic_Operators.html @@ -25,10 +25,12 @@ (str "No match in new-individual for " op))))))})
:variation
. For example:lein run -m propeller.problems.simple-regression :variation "{:new-genetic-operator 1.0}"
propeller.selection.cljc
propeller.selection.cljc
, add the new genetic operator in the select-parent
function under the case
call.:parent-selection
For example:
lein run -m propeller.problems.simple-regression :parent-selection :new-genetic-operator
-